{"openapi":"3.0.0","info":{"description":"General end points to access DAM data and related data.\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 DAM API","contact":{"email":"support@wedia-group.com"}},"servers":[{"url":"https://club-wed.wedia-group.com/api/rest/dam"}],"tags":[{"name":"assets","description":"Access to asset resources"},{"name":"access to all resources","description":"Access to all resources (assets, thesaurus, dictionnaries...)."},{"name":"multi-resource access","description":"Search multiple resources in one request."},{"name":"retrieve resource","description":"Get a given resource or list of resources. Search for resources by query or fulltext."},{"name":"creations & modifications","description":"Create or modify resources."},{"name":"deletions","description":"Delete resources."},{"name":"workflows","description":"Show workflow and change resource status."}],"paths":{"/asset":{"get":{"summary":"Find assets.","description":"Returns a list of assets of several types and natures.\n\n---\nTypes:\n* asset\n\n > Application base DAM object\n\n* brand center\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\n* legacy\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\n* product asset\n\n > Product asset for 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\n---\nNatures:\n* image\n* print\n* 3d models\n* digital templates\n* document\n* archive\n* audio\n* text\n* video","tags":["assets","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"query_asset","in":"query","description":"Specific filters for asset resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_brandcenter","in":"query","description":"Specific filters for brand center resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_legacy","in":"query","description":"Specific filters for legacy resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_pimasset","in":"query","description":"Specific filters for product asset resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"rootquery_asset","in":"query","description":"When retrieving a tree, filters the exported asset at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_brandcenter","in":"query","description":"When retrieving a tree, filters the exported brand center at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_legacy","in":"query","description":"When retrieving a tree, filters the exported legacy at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_pimasset","in":"query","description":"When retrieving a tree, filters the exported product asset at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"X-WEDIA-QUERY","in":"header","description":"Specific filters for resources where too long for query parameter.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\n⚠ Value is ignored if corresponding query parameter is specified.","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of assets","content":{"application/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resource types","readOnly":true,"items":{"type":"object","properties":{"resource":{"type":"string","description":"Type of resource.","readOnly":true},"name":{"type":"string","description":"Localized name of resource.","readOnly":true},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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/asset"},"resourcesContext":{"type":"object","description":"List of request contexts (part of configuration built from request parameters) for each resource type","readOnly":true,"additionalProperties":true},"commonContext":{"type":"object","description":"Common request context (part of configuration built from request parameters) for all resource types","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of resources of following types:\n\n\n* asset\n* brand center\n* legacy\n* product asset\n","readOnly":true,"items":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"asset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"asset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandcenter"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandcenter"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"legacy"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"legacy"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"pimasset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"pimasset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}]}},"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}}}}}}}}},"/{assetNature}":{"get":{"summary":"Find assets of the specified nature.","description":"Returns several types of assets of the specified nature.\n\n---\nNatures are:\n* image\n* print\n* 3d models\n* digital templates\n* document\n* archive\n* audio\n* text\n* video","tags":["assets","retrieve resource"],"parameters":[{"name":"assetNature","in":"path","description":"Wanted asset nature.","schema":{"type":"string","enum":["image","print","3d models","digital templates","document","archive","audio","text","video"]},"required":true},{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"query_asset","in":"query","description":"Specific filters for asset resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_brandcenter","in":"query","description":"Specific filters for brand center resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_legacy","in":"query","description":"Specific filters for legacy resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"query_pimasset","in":"query","description":"Specific filters for product asset resource.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"rootquery_asset","in":"query","description":"When retrieving a tree, filters the exported asset at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_brandcenter","in":"query","description":"When retrieving a tree, filters the exported brand center at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_legacy","in":"query","description":"When retrieving a tree, filters the exported legacy at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"rootquery_pimasset","in":"query","description":"When retrieving a tree, filters the exported product asset at the root.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"X-WEDIA-QUERY","in":"header","description":"Specific filters for resources (JSON query syntax) where too long for query parameter.\n\n⚠ Value is ignored if corresponding query parameter is specified.","schema":{"type":"string","example":"{\"id\": {\"eq\": 115}}"},"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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of assets of the specified nature","content":{"application/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resource types","readOnly":true,"items":{"type":"object","properties":{"resource":{"type":"string","description":"Type of resource.","readOnly":true},"name":{"type":"string","description":"Localized name of resource.","readOnly":true},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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/image"},"resourcesContext":{"type":"object","description":"List of request contexts (part of configuration built from request parameters) for each resource type","readOnly":true,"additionalProperties":true},"commonContext":{"type":"object","description":"Common request context (part of configuration built from request parameters) for all resource types","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of resources of following types:\n\n\n* asset\n\n > Application base DAM object\n* brand center\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* legacy\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* product asset\n\n > Product asset for 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","readOnly":true,"items":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"asset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"asset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandcenter"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandcenter"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"legacy"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"legacy"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"pimasset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"pimasset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}]}},"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}}}}}}}}},"/data/aicolor":{"get":{"summary":"Find AI colors resources.","description":"Returns a list of AI colors resources.\n\n\n\n> *AI* / Main color","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicolor).","readOnly":true,"example":"aicolor"},"name":{"type":"string","description":"Localized name of resource (AI colors).","readOnly":true,"example":"AI colors"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicolor"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of AI colors","readOnly":true,"items":{"title":"AI colors","description":"Data structure of resource AI colors. \n\n\n\n> *AI* / Main color","allOf":[{"$ref":"#/components/schemas/resource-aicolor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicolor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/aicolor/list":{"get":{"summary":"Get paginated list of AI colors resources.","description":"Returns a paginated list of AI colors resources.\n\n\n\n> *AI* / Main color","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicolor).","readOnly":true,"example":"aicolor"},"name":{"type":"string","description":"Localized name of resource (AI colors).","readOnly":true,"example":"AI colors"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicolor/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of AI colors","readOnly":true,"items":{"title":"AI colors","description":"Data structure of resource AI colors. \n\n\n\n> *AI* / Main color","allOf":[{"$ref":"#/components/schemas/resource-aicolor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicolor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/aicolor/{resourceId}":{"get":{"summary":"Get a given AI colors resource.","description":"Returns a single AI colors resource for a resource id.\n\n\n\n> *AI* / Main color","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of AI colors to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicolor).","readOnly":true,"example":"aicolor"},"name":{"type":"string","description":"Localized name of resource (AI colors).","readOnly":true,"example":"AI colors"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicolor/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested AI colors resource","allOf":[{"$ref":"#/components/schemas/resource-aicolor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicolor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetiaconcept":{"get":{"summary":"Find AI concepts resources.","description":"Returns a list of AI concepts resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetiaconcept).","readOnly":true,"example":"assetiaconcept"},"name":{"type":"string","description":"Localized name of resource (AI concepts).","readOnly":true,"example":"AI concepts"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetiaconcept"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of AI concepts","readOnly":true,"items":{"title":"AI concepts","description":"Data structure of resource AI concepts.","allOf":[{"$ref":"#/components/schemas/resource-assetiaconcept"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetiaconcept/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetiaconcept/list":{"get":{"summary":"Get paginated list of AI concepts resources.","description":"Returns a paginated list of AI concepts resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetiaconcept).","readOnly":true,"example":"assetiaconcept"},"name":{"type":"string","description":"Localized name of resource (AI concepts).","readOnly":true,"example":"AI concepts"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetiaconcept/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of AI concepts","readOnly":true,"items":{"title":"AI concepts","description":"Data structure of resource AI concepts.","allOf":[{"$ref":"#/components/schemas/resource-assetiaconcept"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetiaconcept/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetiaconcept/{resourceId}":{"get":{"summary":"Get a given AI concepts resource.","description":"Returns a single AI concepts resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of AI concepts to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetiaconcept).","readOnly":true,"example":"assetiaconcept"},"name":{"type":"string","description":"Localized name of resource (AI concepts).","readOnly":true,"example":"AI concepts"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetiaconcept/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested AI concepts resource","allOf":[{"$ref":"#/components/schemas/resource-assetiaconcept"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetiaconcept/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/asset":{"get":{"summary":"Find asset resources.","description":"Returns a list of asset resources.\n\n\n\n> Application base DAM object\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of asset","readOnly":true,"items":{"title":"asset","description":"Data structure of resource asset. \n\n\n\n> Application base DAM object\n","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new asset","description":"In this mode, you can create one new asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"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_source","in":"query","description":"Name, or URI, of the file to store in the property source 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_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_langs","in":"query","description":"Identifiers of languages to set property languages","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_contract","in":"query","description":"Identifier of contract to set to property contract","schema":{"type":"string"},"required":false},{"name":"prop_ai_concepts","in":"query","description":"Identifiers of ai concepts to set property ai concepts","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_contract":{"description":"Identifier of contract to set to property contract","type":"string"},"prop_ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/asset/list":{"get":{"summary":"Get paginated list of asset resources.","description":"Returns a paginated list of asset resources.\n\n\n\n> Application base DAM object\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of asset","readOnly":true,"items":{"title":"asset","description":"Data structure of resource asset. \n\n\n\n> Application base DAM object\n","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/asset/{resourceId}":{"get":{"summary":"Get a given asset resource.","description":"Returns a single asset resource for a resource id.\n\n\n\n> Application base DAM object\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested asset resource","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given asset","description":"In this mode, you can modify the asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset to get.","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_source","in":"query","description":"Name, or URI, of the file to store in the property source 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_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_langs","in":"query","description":"Identifiers of languages to set property languages","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_contract","in":"query","description":"Identifier of contract to set to property contract","schema":{"type":"string"},"required":false},{"name":"prop_ai_concepts","in":"query","description":"Identifiers of ai concepts to set property ai concepts","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_contract":{"description":"Identifier of contract to set to property contract","type":"string"},"prop_ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given asset","description":"In this mode, you can modify the asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset 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_source","in":"query","description":"Name, or URI, of the file to store in the property source 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_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_langs","in":"query","description":"Identifiers of languages to set property languages","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_contract","in":"query","description":"Identifier of contract to set to property contract","schema":{"type":"string"},"required":false},{"name":"prop_ai_concepts","in":"query","description":"Identifiers of ai concepts to set property ai concepts","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_contract":{"description":"Identifier of contract to set to property contract","type":"string"},"prop_ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given asset","description":"Delete definitively a asset","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/asset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/asset/{resourceId}/put":{"post":{"summary":"Modify a given asset","description":"In this mode, you can modify the asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/asset/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset to get.","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_source","in":"query","description":"Name, or URI, of the file to store in the property source 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_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_langs","in":"query","description":"Identifiers of languages to set property languages","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_contract","in":"query","description":"Identifier of contract to set to property contract","schema":{"type":"string"},"required":false},{"name":"prop_ai_concepts","in":"query","description":"Identifiers of ai concepts to set property ai concepts","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}},"required":["rekousers","langs","season","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_contract":{"description":"Identifier of contract to set to property contract","type":"string"},"prop_ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/asset/{resourceId}/patch":{"post":{"summary":"Modify partially a given asset","description":"In this mode, you can modify the asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/asset/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset 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_source","in":"query","description":"Name, or URI, of the file to store in the property source 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_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_langs","in":"query","description":"Identifiers of languages to set property languages","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_contract","in":"query","description":"Identifier of contract to set to property contract","schema":{"type":"string"},"required":false},{"name":"prop_ai_concepts","in":"query","description":"Identifiers of ai concepts to set property ai concepts","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"season":{"description":"Identifier of season to set to property season","type":"string"},"coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"contract":{"description":"Identifier of contract to set to property contract","type":"string"},"ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"}}},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_source":{"description":"Name, URI of the file or binary content to store in the property source 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_langs":{"description":"Identifiers of languages to set property languages","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Languages."},{"type":"integer","format":"int32","description":"ID of Languages."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_folder":{"description":"Identifiers of folder to set property folder","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_contract":{"description":"Identifier of contract to set to property contract","type":"string"},"prop_ai_concepts":{"description":"Identifiers of ai concepts to set property ai concepts","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of AI concepts."},{"type":"integer","format":"int32","description":"ID of AI concepts."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/asset/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/asset/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of asset resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary","source","poster"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/asset/{resourceId}/$workcopy":{"get":{"summary":"Get a workcopy of a given asset","description":"Returns a workcopy of specified asset (create if necessary).\n\n\n\n> Application base DAM object\n","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The current editable version of the resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested asset resource","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}},"201":{"description":"A new editable version of resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested asset resource","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/asset/workflow":{"get":{"summary":"Get asset workflow.","description":"Returns the whole workflow tree of asset resources.\n\n\n\n> Application base DAM object\n","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of asset","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/asset/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given asset.","description":"Returns all possible workflow actions to apply to a given asset.\n\n\n\n> Application base DAM object\n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the asset of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified asset.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given asset.","description":"Change the workflow state of specified asset.\n\n\n\n> Application base DAM object\n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the asset whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (asset).","readOnly":true,"example":"asset"},"name":{"type":"string","description":"Localized name of resource (asset).","readOnly":true,"example":"asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/asset/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/assetnature":{"get":{"summary":"Find asset type resources.","description":"Returns a list of asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetnature).","readOnly":true,"example":"assetnature"},"name":{"type":"string","description":"Localized name of resource (asset type).","readOnly":true,"example":"asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetnature"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of asset type","readOnly":true,"items":{"title":"asset type","description":"Data structure of resource asset type.","allOf":[{"$ref":"#/components/schemas/resource-assetnature"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetnature/list":{"get":{"summary":"Get paginated list of asset type resources.","description":"Returns a paginated list of asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetnature).","readOnly":true,"example":"assetnature"},"name":{"type":"string","description":"Localized name of resource (asset type).","readOnly":true,"example":"asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetnature/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of asset type","readOnly":true,"items":{"title":"asset type","description":"Data structure of resource asset type.","allOf":[{"$ref":"#/components/schemas/resource-assetnature"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetnature/tree":{"get":{"summary":"Get asset type resources as tree.","description":"Returns a tree view of asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetnature).","readOnly":true,"example":"assetnature"},"name":{"type":"string","description":"Localized name of resource (asset type).","readOnly":true,"example":"asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetnature/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of asset type","readOnly":true,"items":{"title":"asset type","description":"Data structure of resource asset type.","allOf":[{"$ref":"#/components/schemas/resource-assetnature"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetnature/{resourceId}":{"get":{"summary":"Get a given asset type resource.","description":"Returns a single asset type resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset type to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetnature).","readOnly":true,"example":"assetnature"},"name":{"type":"string","description":"Localized name of resource (asset type).","readOnly":true,"example":"asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetnature/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested asset type resource","allOf":[{"$ref":"#/components/schemas/resource-assetnature"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetvisibility":{"get":{"summary":"Find asset visibility resources.","description":"Returns a list of asset visibility resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetvisibility).","readOnly":true,"example":"assetvisibility"},"name":{"type":"string","description":"Localized name of resource (asset visibility).","readOnly":true,"example":"asset visibility"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetvisibility"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of asset visibility","readOnly":true,"items":{"title":"asset visibility","description":"Data structure of resource asset visibility.","allOf":[{"$ref":"#/components/schemas/resource-assetvisibility"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetvisibility/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetvisibility/list":{"get":{"summary":"Get paginated list of asset visibility resources.","description":"Returns a paginated list of asset visibility resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetvisibility).","readOnly":true,"example":"assetvisibility"},"name":{"type":"string","description":"Localized name of resource (asset visibility).","readOnly":true,"example":"asset visibility"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetvisibility/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of asset visibility","readOnly":true,"items":{"title":"asset visibility","description":"Data structure of resource asset visibility.","allOf":[{"$ref":"#/components/schemas/resource-assetvisibility"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetvisibility/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetvisibility/{resourceId}":{"get":{"summary":"Get a given asset visibility resource.","description":"Returns a single asset visibility resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of asset visibility to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetvisibility).","readOnly":true,"example":"assetvisibility"},"name":{"type":"string","description":"Localized name of resource (asset visibility).","readOnly":true,"example":"asset visibility"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetvisibility/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested asset visibility resource","allOf":[{"$ref":"#/components/schemas/resource-assetvisibility"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetvisibility/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetgrouping":{"get":{"summary":"Find assetgrouping resources.","description":"Returns a list of assetgrouping resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"name":{"type":"string","description":"Localized name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgrouping"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of assetgrouping","readOnly":true,"items":{"title":"assetgrouping","description":"Data structure of resource assetgrouping.","allOf":[{"$ref":"#/components/schemas/resource-assetgrouping"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgrouping/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetgrouping/list":{"get":{"summary":"Get paginated list of assetgrouping resources.","description":"Returns a paginated list of assetgrouping resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"name":{"type":"string","description":"Localized name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgrouping/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of assetgrouping","readOnly":true,"items":{"title":"assetgrouping","description":"Data structure of resource assetgrouping.","allOf":[{"$ref":"#/components/schemas/resource-assetgrouping"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgrouping/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetgrouping/{resourceId}":{"get":{"summary":"Get a given assetgrouping resource.","description":"Returns a single assetgrouping resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of assetgrouping to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"name":{"type":"string","description":"Localized name of resource (assetgrouping).","readOnly":true,"example":"assetgrouping"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgrouping/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested assetgrouping resource","allOf":[{"$ref":"#/components/schemas/resource-assetgrouping"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgrouping/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/brandassettype":{"get":{"summary":"Find brand asset type resources.","description":"Returns a list of brand asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of brand asset type","readOnly":true,"items":{"title":"brand asset type","description":"Data structure of resource brand asset type.","allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new brand asset type","description":"Create one new brand asset type setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandassettype/list":{"get":{"summary":"Get paginated list of brand asset type resources.","description":"Returns a paginated list of brand asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of brand asset type","readOnly":true,"items":{"title":"brand asset type","description":"Data structure of resource brand asset type.","allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/brandassettype/{resourceId}":{"get":{"summary":"Get a given brand asset type resource.","description":"Returns a single brand asset type resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brand asset type resource","allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given brand asset type","description":"Modify the brand asset type setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given brand asset type","description":"Modify the brand asset type setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given brand asset type","description":"Delete definitively a brand asset type","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/brandassettype/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/brandassettype/{resourceId}/put":{"post":{"summary":"Modify a given brand asset type","description":"Modify the brand asset type setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/brand asset type/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandassettype/{resourceId}/patch":{"post":{"summary":"Modify partially a given brand asset type","description":"Modify the brand asset type setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/brand asset type/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand asset type 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandassettype/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandassettype/workflow":{"get":{"summary":"Get brand asset type workflow.","description":"Returns the whole workflow tree of brand asset type resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of brand asset type","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandassettype/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given brand asset type.","description":"Returns all possible workflow actions to apply to a given brand asset type.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brand asset type of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified brand asset type.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given brand asset type.","description":"Change the workflow state of specified brand asset type.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brand asset type whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandassettype).","readOnly":true,"example":"brandassettype"},"name":{"type":"string","description":"Localized name of resource (brand asset type).","readOnly":true,"example":"brand asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandassettype/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandcenter":{"get":{"summary":"Find brand center resources.","description":"Returns a list of brand center resources.\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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of brand center","readOnly":true,"items":{"title":"brand center","description":"Data structure of resource 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","allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new brand center","description":"In this mode, you can create one new brand center from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brand center to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_nameen","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionen","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_originalfilename","in":"query","description":"Value to set to property original file name.","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_nameen":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionen":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_originalfilename":{"description":"Value to set to property original file name.","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcenter/list":{"get":{"summary":"Get paginated list of brand center resources.","description":"Returns a paginated list of brand center resources.\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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of brand center","readOnly":true,"items":{"title":"brand center","description":"Data structure of resource 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","allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/brandcenter/{resourceId}":{"get":{"summary":"Get a given brand center resource.","description":"Returns a single brand center resource for a resource 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":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brand center resource","allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given brand center","description":"In this mode, you can modify the brand center from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brand center to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_nameen","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionen","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_originalfilename","in":"query","description":"Value to set to property original file name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given brand center","description":"In this mode, you can modify the brand center from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brand center to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_nameen","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionen","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_originalfilename","in":"query","description":"Value to set to property original file name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_nameen":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionen":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_originalfilename":{"description":"Value to set to property original file name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given brand center","description":"Delete definitively a brand center","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/brandcenter/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/brandcenter/{resourceId}/put":{"post":{"summary":"Modify a given brand center","description":"In this mode, you can modify the brand center from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brand center to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/brand center/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_nameen","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionen","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_originalfilename","in":"query","description":"Value to set to property original file name.","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","nameen","namefr","namede","descriptionen","descriptionfr","descriptionde","keywords","copyright","righttype","photograph","shootingdate","dteendrights","visibility","originalfilename","displayweight","organization","binaryorigin","grouping","groupingmaster","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_nameen":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionen":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_originalfilename":{"description":"Value to set to property original file name.","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcenter/{resourceId}/patch":{"post":{"summary":"Modify partially a given brand center","description":"In this mode, you can modify the brand center from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brand center to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/brand center/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_nameen","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionen","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_brandassettype","in":"query","description":"Identifier of brand asset type to set to property brand asset type","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_originalfilename","in":"query","description":"Value to set to property original file name.","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"nameen":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionen":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"originalfilename":{"description":"Value to set to property original file name.","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_nameen":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionen":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_brandassettype":{"description":"Identifier of brand asset type to set to property brand asset type","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_originalfilename":{"description":"Value to set to property original file name.","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcenter/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcenter/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of brand center resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/brandcenter/{resourceId}/$workcopy":{"get":{"summary":"Get a workcopy of a given brand center","description":"Returns a workcopy of specified brand center (create if necessary).\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":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brand center to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The current editable version of the resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brand center resource","allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}},"201":{"description":"A new editable version of resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brand center resource","allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/brandcenter/workflow":{"get":{"summary":"Get brand center workflow.","description":"Returns the whole workflow tree of brand center resources.\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":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of brand center","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandcenter/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given brand center.","description":"Returns all possible workflow actions to apply to a given 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":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brand center of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified brand center.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given brand center.","description":"Change the workflow state of 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":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brand center whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcenter).","readOnly":true,"example":"brandcenter"},"name":{"type":"string","description":"Localized name of resource (brand center).","readOnly":true,"example":"brand center"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcenter/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandcriterion":{"get":{"summary":"Find brandcriterion resources.","description":"Returns a list of brandcriterion resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcriterion"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of brandcriterion","readOnly":true,"items":{"title":"brandcriterion","description":"Data structure of resource brandcriterion.","allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new brandcriterion","description":"Create one new brandcriterion setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_category","in":"query","description":"Value to set to property category.","schema":{"type":"string"},"required":false},{"name":"prop_label","in":"query","description":"Value to set to property label.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_importance","in":"query","description":"Value to set to property importance.","schema":{"type":"string"},"required":false},{"name":"prop_weight","in":"query","description":"Value to set to property weight.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_styletoken","in":"query","description":"Value to set to property styletoken.","schema":{"type":"string"},"required":false},{"name":"prop_source","in":"query","description":"Value to set to property source file.","schema":{"type":"string"},"required":false},{"name":"prop_avoidtoken","in":"query","description":"Value to set to property avoidtoken.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_category":{"description":"Value to set to property category.","type":"string"},"prop_label":{"description":"Value to set to property label.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_importance":{"description":"Value to set to property importance.","type":"string"},"prop_weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"prop_styletoken":{"description":"Value to set to property styletoken.","type":"string"},"prop_source":{"description":"Value to set to property source file.","type":"string"},"prop_avoidtoken":{"description":"Value to set to property avoidtoken.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcriterion/list":{"get":{"summary":"Get paginated list of brandcriterion resources.","description":"Returns a paginated list of brandcriterion resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcriterion/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of brandcriterion","readOnly":true,"items":{"title":"brandcriterion","description":"Data structure of resource brandcriterion.","allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/brandcriterion/{resourceId}":{"get":{"summary":"Get a given brandcriterion resource.","description":"Returns a single brandcriterion resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandcriterion to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandcriterion/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brandcriterion resource","allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given brandcriterion","description":"Modify the brandcriterion setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandcriterion to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_category","in":"query","description":"Value to set to property category.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_label","in":"query","description":"Value to set to property label.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_importance","in":"query","description":"Value to set to property importance.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_weight","in":"query","description":"Value to set to property weight.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_styletoken","in":"query","description":"Value to set to property styletoken.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_source","in":"query","description":"Value to set to property source file.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_avoidtoken","in":"query","description":"Value to set to property avoidtoken.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"prop_styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given brandcriterion","description":"Modify the brandcriterion setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandcriterion to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_category","in":"query","description":"Value to set to property category.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_label","in":"query","description":"Value to set to property label.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_importance","in":"query","description":"Value to set to property importance.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_weight","in":"query","description":"Value to set to property weight.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_styletoken","in":"query","description":"Value to set to property styletoken.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_source","in":"query","description":"Value to set to property source file.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_avoidtoken","in":"query","description":"Value to set to property avoidtoken.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_category":{"description":"Value to set to property category.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_label":{"description":"Value to set to property label.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_importance":{"description":"Value to set to property importance.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"prop_styletoken":{"description":"Value to set to property styletoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_source":{"description":"Value to set to property source file.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_avoidtoken":{"description":"Value to set to property avoidtoken.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcriterion/{resourceId}/put":{"post":{"summary":"Modify a given brandcriterion","description":"Modify the brandcriterion setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/brandcriterion/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandcriterion to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_category","in":"query","description":"Value to set to property category.","schema":{"type":"string"},"required":false},{"name":"prop_label","in":"query","description":"Value to set to property label.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_importance","in":"query","description":"Value to set to property importance.","schema":{"type":"string"},"required":false},{"name":"prop_weight","in":"query","description":"Value to set to property weight.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_styletoken","in":"query","description":"Value to set to property styletoken.","schema":{"type":"string"},"required":false},{"name":"prop_source","in":"query","description":"Value to set to property source file.","schema":{"type":"string"},"required":false},{"name":"prop_avoidtoken","in":"query","description":"Value to set to property avoidtoken.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}},"required":["name","category","label","description","importance","weight","styletoken","source","avoidtoken"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_category":{"description":"Value to set to property category.","type":"string"},"prop_label":{"description":"Value to set to property label.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_importance":{"description":"Value to set to property importance.","type":"string"},"prop_weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"prop_styletoken":{"description":"Value to set to property styletoken.","type":"string"},"prop_source":{"description":"Value to set to property source file.","type":"string"},"prop_avoidtoken":{"description":"Value to set to property avoidtoken.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandcriterion/{resourceId}/patch":{"post":{"summary":"Modify partially a given brandcriterion","description":"Modify the brandcriterion setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/brandcriterion/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandcriterion 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_category","in":"query","description":"Value to set to property category.","schema":{"type":"string"},"required":false},{"name":"prop_label","in":"query","description":"Value to set to property label.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_importance","in":"query","description":"Value to set to property importance.","schema":{"type":"string"},"required":false},{"name":"prop_weight","in":"query","description":"Value to set to property weight.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_styletoken","in":"query","description":"Value to set to property styletoken.","schema":{"type":"string"},"required":false},{"name":"prop_source","in":"query","description":"Value to set to property source file.","schema":{"type":"string"},"required":false},{"name":"prop_avoidtoken","in":"query","description":"Value to set to property avoidtoken.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"category":{"description":"Value to set to property category.","type":"string"},"label":{"description":"Value to set to property label.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"importance":{"description":"Value to set to property importance.","type":"string"},"weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"styletoken":{"description":"Value to set to property styletoken.","type":"string"},"source":{"description":"Value to set to property source file.","type":"string"},"avoidtoken":{"description":"Value to set to property avoidtoken.","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_category":{"description":"Value to set to property category.","type":"string"},"prop_label":{"description":"Value to set to property label.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_importance":{"description":"Value to set to property importance.","type":"string"},"prop_weight":{"description":"Value to set to property weight.","type":"integer","format":"int32"},"prop_styletoken":{"description":"Value to set to property styletoken.","type":"string"},"prop_source":{"description":"Value to set to property source file.","type":"string"},"prop_avoidtoken":{"description":"Value to set to property avoidtoken.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"name":{"type":"string","description":"Localized name of resource (brandcriterion).","readOnly":true,"example":"brandcriterion"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandcriterion/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandguideline":{"get":{"summary":"Find brandguideline resources.","description":"Returns a list of brandguideline resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of brandguideline","readOnly":true,"items":{"title":"brandguideline","description":"Data structure of resource brandguideline.","allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new brandguideline","description":"In this mode, you can create one new brandguideline from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brandguideline to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_threshold","in":"query","description":"Value to set to property minimum score.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"*/*":{"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandguideline/list":{"get":{"summary":"Get paginated list of brandguideline resources.","description":"Returns a paginated list of brandguideline resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of brandguideline","readOnly":true,"items":{"title":"brandguideline","description":"Data structure of resource brandguideline.","allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/brandguideline/{resourceId}":{"get":{"summary":"Get a given brandguideline resource.","description":"Returns a single brandguideline resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brandguideline resource","allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given brandguideline","description":"In this mode, you can modify the brandguideline from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brandguideline to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_threshold","in":"query","description":"Value to set to property minimum score.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given brandguideline","description":"In this mode, you can modify the brandguideline from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brandguideline to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_threshold","in":"query","description":"Value to set to property minimum score.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandguideline/{resourceId}/put":{"post":{"summary":"Modify a given brandguideline","description":"In this mode, you can modify the brandguideline from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brandguideline to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/brandguideline/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_threshold","in":"query","description":"Value to set to property minimum score.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}},"required":["name","threshold"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandguideline/{resourceId}/patch":{"post":{"summary":"Modify partially a given brandguideline","description":"In this mode, you can modify the brandguideline from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new brandguideline to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/brandguideline/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline 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_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_threshold","in":"query","description":"Value to set to property minimum score.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_threshold":{"description":"Value to set to property minimum score.","type":"integer","format":"int32"}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/brandguideline/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/brandguideline/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of brandguideline resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["logo"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/brandguideline/{resourceId}/$workcopy":{"get":{"summary":"Get a workcopy of a given brandguideline","description":"Returns a workcopy of specified brandguideline (create if necessary).","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandguideline to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The current editable version of the resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brandguideline resource","allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}},"201":{"description":"A new editable version of resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brandguideline resource","allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/brandguideline/workflow":{"get":{"summary":"Get brandguideline workflow.","description":"Returns the whole workflow tree of brandguideline resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of brandguideline","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandguideline/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given brandguideline.","description":"Returns all possible workflow actions to apply to a given brandguideline.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brandguideline of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified brandguideline.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given brandguideline.","description":"Change the workflow state of specified brandguideline.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the brandguideline whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"name":{"type":"string","description":"Localized name of resource (brandguideline).","readOnly":true,"example":"brandguideline"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandguideline/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/brandreference":{"get":{"summary":"Find brandreference resources.","description":"Returns a list of brandreference resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandreference).","readOnly":true,"example":"brandreference"},"name":{"type":"string","description":"Localized name of resource (brandreference).","readOnly":true,"example":"brandreference"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandreference"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of brandreference","readOnly":true,"items":{"title":"brandreference","description":"Data structure of resource brandreference.","allOf":[{"$ref":"#/components/schemas/resource-brandreference"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/brandreference/list":{"get":{"summary":"Get paginated list of brandreference resources.","description":"Returns a paginated list of brandreference resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandreference).","readOnly":true,"example":"brandreference"},"name":{"type":"string","description":"Localized name of resource (brandreference).","readOnly":true,"example":"brandreference"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandreference/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of brandreference","readOnly":true,"items":{"title":"brandreference","description":"Data structure of resource brandreference.","allOf":[{"$ref":"#/components/schemas/resource-brandreference"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/brandreference/{resourceId}":{"get":{"summary":"Get a given brandreference resource.","description":"Returns a single brandreference resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandreference to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (brandreference).","readOnly":true,"example":"brandreference"},"name":{"type":"string","description":"Localized name of resource (brandreference).","readOnly":true,"example":"brandreference"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/brandreference/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested brandreference resource","allOf":[{"$ref":"#/components/schemas/resource-brandreference"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/brandreference/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of brandreference resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of brandreference resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/aicelebrity":{"get":{"summary":"Find celebrity resources.","description":"Returns a list of celebrity resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicelebrity).","readOnly":true,"example":"aicelebrity"},"name":{"type":"string","description":"Localized name of resource (celebrity).","readOnly":true,"example":"celebrity"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicelebrity"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of celebrity","readOnly":true,"items":{"title":"celebrity","description":"Data structure of resource celebrity.","allOf":[{"$ref":"#/components/schemas/resource-aicelebrity"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicelebrity/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/aicelebrity/list":{"get":{"summary":"Get paginated list of celebrity resources.","description":"Returns a paginated list of celebrity resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicelebrity).","readOnly":true,"example":"aicelebrity"},"name":{"type":"string","description":"Localized name of resource (celebrity).","readOnly":true,"example":"celebrity"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicelebrity/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of celebrity","readOnly":true,"items":{"title":"celebrity","description":"Data structure of resource celebrity.","allOf":[{"$ref":"#/components/schemas/resource-aicelebrity"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicelebrity/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/aicelebrity/{resourceId}":{"get":{"summary":"Get a given celebrity resource.","description":"Returns a single celebrity resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of celebrity to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (aicelebrity).","readOnly":true,"example":"aicelebrity"},"name":{"type":"string","description":"Localized name of resource (celebrity).","readOnly":true,"example":"celebrity"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/aicelebrity/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested celebrity resource","allOf":[{"$ref":"#/components/schemas/resource-aicelebrity"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicelebrity/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetchannel":{"get":{"summary":"Find channel resources.","description":"Returns a list of channel resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetchannel).","readOnly":true,"example":"assetchannel"},"name":{"type":"string","description":"Localized name of resource (channel).","readOnly":true,"example":"channel"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetchannel"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of channel","readOnly":true,"items":{"title":"channel","description":"Data structure of resource channel.","allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new channel","description":"Create one new channel setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name","namefr","namede"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name","namefr","namede"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetchannel).","readOnly":true,"example":"assetchannel"},"name":{"type":"string","description":"Localized name of resource (channel).","readOnly":true,"example":"channel"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetchannel"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetchannel).","readOnly":true,"example":"assetchannel"},"name":{"type":"string","description":"Localized name of resource (channel).","readOnly":true,"example":"channel"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetchannel"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetchannel"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetchannel/list":{"get":{"summary":"Get paginated list of channel resources.","description":"Returns a paginated list of channel resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetchannel).","readOnly":true,"example":"assetchannel"},"name":{"type":"string","description":"Localized name of resource (channel).","readOnly":true,"example":"channel"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetchannel/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of channel","readOnly":true,"items":{"title":"channel","description":"Data structure of resource channel.","allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetchannel/{resourceId}":{"get":{"summary":"Get a given channel resource.","description":"Returns a single channel resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of channel to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetchannel).","readOnly":true,"example":"assetchannel"},"name":{"type":"string","description":"Localized name of resource (channel).","readOnly":true,"example":"channel"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetchannel/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested channel resource","allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/collaborativespace":{"get":{"summary":"Find collaborativespace resources.","description":"Returns a list of collaborativespace resources.\n\n\n\n> This object represents a collaborative space.\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"name":{"type":"string","description":"Localized name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/collaborativespace"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of collaborativespace","readOnly":true,"items":{"title":"collaborativespace","description":"Data structure of resource collaborativespace. \n\n\n\n> This object represents a collaborative space.\n","allOf":[{"$ref":"#/components/schemas/resource-collaborativespace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/collaborativespace/list":{"get":{"summary":"Get paginated list of collaborativespace resources.","description":"Returns a paginated list of collaborativespace resources.\n\n\n\n> This object represents a collaborative space.\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"name":{"type":"string","description":"Localized name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/collaborativespace/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of collaborativespace","readOnly":true,"items":{"title":"collaborativespace","description":"Data structure of resource collaborativespace. \n\n\n\n> This object represents a collaborative space.\n","allOf":[{"$ref":"#/components/schemas/resource-collaborativespace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/collaborativespace/{resourceId}":{"get":{"summary":"Get a given collaborativespace resource.","description":"Returns a single collaborativespace resource for a resource id.\n\n\n\n> This object represents a collaborative space.\n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collaborativespace to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"name":{"type":"string","description":"Localized name of resource (collaborativespace).","readOnly":true,"example":"collaborativespace"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/collaborativespace/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested collaborativespace resource","allOf":[{"$ref":"#/components/schemas/resource-collaborativespace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetcoverage":{"get":{"summary":"Find collection resources.","description":"Returns a list of collection resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcoverage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of collection","readOnly":true,"items":{"title":"collection","description":"Data structure of resource collection.","allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new collection","description":"Create one new collection setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetcoverage/list":{"get":{"summary":"Get paginated list of collection resources.","description":"Returns a paginated list of collection resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcoverage/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of collection","readOnly":true,"items":{"title":"collection","description":"Data structure of resource collection.","allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetcoverage/{resourceId}":{"get":{"summary":"Get a given collection resource.","description":"Returns a single collection resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collection to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcoverage/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested collection resource","allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given collection","description":"Modify the collection setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collection to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given collection","description":"Modify the collection setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collection to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetcoverage/{resourceId}/put":{"post":{"summary":"Modify a given collection","description":"Modify the collection setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/collection/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collection to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetcoverage/{resourceId}/patch":{"post":{"summary":"Modify partially a given collection","description":"Modify the collection setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/collection/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of collection 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetcoverage).","readOnly":true,"example":"assetcoverage"},"name":{"type":"string","description":"Localized name of resource (collection).","readOnly":true,"example":"collection"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetcoverage/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetcolorspace":{"get":{"summary":"Find color space resources.","description":"Returns a list of color space resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcolorspace).","readOnly":true,"example":"assetcolorspace"},"name":{"type":"string","description":"Localized name of resource (color space).","readOnly":true,"example":"color space"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcolorspace"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of color space","readOnly":true,"items":{"title":"color space","description":"Data structure of resource color space.","allOf":[{"$ref":"#/components/schemas/resource-assetcolorspace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcolorspace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetcolorspace/list":{"get":{"summary":"Get paginated list of color space resources.","description":"Returns a paginated list of color space resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcolorspace).","readOnly":true,"example":"assetcolorspace"},"name":{"type":"string","description":"Localized name of resource (color space).","readOnly":true,"example":"color space"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcolorspace/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of color space","readOnly":true,"items":{"title":"color space","description":"Data structure of resource color space.","allOf":[{"$ref":"#/components/schemas/resource-assetcolorspace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcolorspace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetcolorspace/{resourceId}":{"get":{"summary":"Get a given color space resource.","description":"Returns a single color space resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of color space to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetcolorspace).","readOnly":true,"example":"assetcolorspace"},"name":{"type":"string","description":"Localized name of resource (color space).","readOnly":true,"example":"color space"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetcolorspace/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested color space resource","allOf":[{"$ref":"#/components/schemas/resource-assetcolorspace"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcolorspace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/contract":{"get":{"summary":"Find contract resources.","description":"Returns a list of contract resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of contract","readOnly":true,"items":{"title":"contract","description":"Data structure of resource contract.","allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new contract","description":"In this mode, you can create one new contract from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new contract to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"prop_attachedfile","in":"query","description":"Name, or URI, of the file to store in the property attached 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":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_attachedfile by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","type":"string"},"prop_attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/contract/list":{"get":{"summary":"Get paginated list of contract resources.","description":"Returns a paginated list of contract resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of contract","readOnly":true,"items":{"title":"contract","description":"Data structure of resource contract.","allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/contract/{resourceId}":{"get":{"summary":"Get a given contract resource.","description":"Returns a single contract resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested contract resource","allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given contract","description":"In this mode, you can modify the contract from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new contract to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_attachedfile","in":"query","description":"Name, or URI, of the file to store in the property attached 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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_attachedfile by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given contract","description":"In this mode, you can modify the contract from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new contract to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_attachedfile","in":"query","description":"Name, or URI, of the file to store in the property attached 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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_attachedfile by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given contract","description":"Delete definitively a contract","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/contract/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/contract/{resourceId}/put":{"post":{"summary":"Modify a given contract","description":"In this mode, you can modify the contract from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new contract to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/contract/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"prop_attachedfile","in":"query","description":"Name, or URI, of the file to store in the property attached 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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_attachedfile by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","type":"string"},"prop_attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/contract/{resourceId}/patch":{"post":{"summary":"Modify partially a given contract","description":"In this mode, you can modify the contract from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new contract to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/contract/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"prop_attachedfile","in":"query","description":"Name, or URI, of the file to store in the property attached 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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_attachedfile by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"},"attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","type":"string"},"prop_attachedfile":{"description":"Name, URI of the file or binary content to store in the property attached 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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/contract/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/contract/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of contract resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of contract resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["attachedfile"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/contract/workflow":{"get":{"summary":"Get contract workflow.","description":"Returns the whole workflow tree of contract resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of contract","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/contract/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given contract.","description":"Returns all possible workflow actions to apply to a given contract.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the contract of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified contract.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given contract.","description":"Change the workflow state of specified contract.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the contract whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (contract).","readOnly":true,"example":"contract"},"name":{"type":"string","description":"Localized name of resource (contract).","readOnly":true,"example":"contract"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/contract/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/country":{"get":{"summary":"Find country resources.","description":"Returns a list of country resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (country).","readOnly":true,"example":"country"},"name":{"type":"string","description":"Localized name of resource (country).","readOnly":true,"example":"country"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/country"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of country","readOnly":true,"items":{"title":"country","description":"Data structure of resource country.","allOf":[{"$ref":"#/components/schemas/resource-country"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/country/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/country/list":{"get":{"summary":"Get paginated list of country resources.","description":"Returns a paginated list of country resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (country).","readOnly":true,"example":"country"},"name":{"type":"string","description":"Localized name of resource (country).","readOnly":true,"example":"country"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/country/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of country","readOnly":true,"items":{"title":"country","description":"Data structure of resource country.","allOf":[{"$ref":"#/components/schemas/resource-country"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/country/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/country/{resourceId}":{"get":{"summary":"Get a given country resource.","description":"Returns a single country resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of country to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (country).","readOnly":true,"example":"country"},"name":{"type":"string","description":"Localized name of resource (country).","readOnly":true,"example":"country"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/country/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested country resource","allOf":[{"$ref":"#/components/schemas/resource-country"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/country/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/cspsource":{"get":{"summary":"Find cspsource resources.","description":"Returns a list of cspsource resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (cspsource).","readOnly":true,"example":"cspsource"},"name":{"type":"string","description":"Localized name of resource (cspsource).","readOnly":true,"example":"cspsource"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/cspsource"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of cspsource","readOnly":true,"items":{"title":"cspsource","description":"Data structure of resource cspsource.","allOf":[{"$ref":"#/components/schemas/resource-cspsource"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/cspsource/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/cspsource/list":{"get":{"summary":"Get paginated list of cspsource resources.","description":"Returns a paginated list of cspsource resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (cspsource).","readOnly":true,"example":"cspsource"},"name":{"type":"string","description":"Localized name of resource (cspsource).","readOnly":true,"example":"cspsource"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/cspsource/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of cspsource","readOnly":true,"items":{"title":"cspsource","description":"Data structure of resource cspsource.","allOf":[{"$ref":"#/components/schemas/resource-cspsource"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/cspsource/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/cspsource/{resourceId}":{"get":{"summary":"Get a given cspsource resource.","description":"Returns a single cspsource resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of cspsource to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (cspsource).","readOnly":true,"example":"cspsource"},"name":{"type":"string","description":"Localized name of resource (cspsource).","readOnly":true,"example":"cspsource"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/cspsource/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested cspsource resource","allOf":[{"$ref":"#/components/schemas/resource-cspsource"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/cspsource/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/folder":{"get":{"summary":"Find folder resources.","description":"Returns a list of folder resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/folder"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of folder","readOnly":true,"items":{"title":"folder","description":"Data structure of resource folder.","allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new folder","description":"Create one new folder setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_parentfolder","in":"query","description":"Identifier of folder to set to property enclosing folder","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"parentfolder":{"description":"Identifier of folder to set to property enclosing folder","type":"string"}},"required":["name","parentfolder"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"parentfolder":{"description":"Identifier of folder to set to property enclosing folder","type":"string"}},"required":["name","parentfolder"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_parentfolder":{"description":"Identifier of folder to set to property enclosing folder","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/folder"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/folder"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/folder"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/folder/list":{"get":{"summary":"Get paginated list of folder resources.","description":"Returns a paginated list of folder resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/folder/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of folder","readOnly":true,"items":{"title":"folder","description":"Data structure of resource folder.","allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/folder/tree":{"get":{"summary":"Get folder resources as tree.","description":"Returns a tree view of folder resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/folder/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of folder","readOnly":true,"items":{"title":"folder","description":"Data structure of resource folder.","allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/folder/{resourceId}":{"get":{"summary":"Get a given folder resource.","description":"Returns a single folder resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of folder to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (folder).","readOnly":true,"example":"folder"},"name":{"type":"string","description":"Localized name of resource (folder).","readOnly":true,"example":"folder"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/folder/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested folder resource","allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/gartnerdemo":{"get":{"summary":"Find gartner demo resources.","description":"Returns a list of gartner demo resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of gartner demo","readOnly":true,"items":{"title":"gartner demo","description":"Data structure of resource gartner demo.","allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new gartner demo","description":"Create one new gartner demo setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/gartnerdemo/list":{"get":{"summary":"Get paginated list of gartner demo resources.","description":"Returns a paginated list of gartner demo resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of gartner demo","readOnly":true,"items":{"title":"gartner demo","description":"Data structure of resource gartner demo.","allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/gartnerdemo/{resourceId}":{"get":{"summary":"Get a given gartner demo resource.","description":"Returns a single gartner demo resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested gartner demo resource","allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given gartner demo","description":"Modify the gartner demo setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given gartner demo","description":"Modify the gartner demo setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (es).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given gartner demo","description":"Delete definitively a gartner demo","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/gartnerdemo/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/gartnerdemo/{resourceId}/put":{"post":{"summary":"Modify a given gartner demo","description":"Modify the gartner demo setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/gartner demo/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/gartnerdemo/{resourceId}/patch":{"post":{"summary":"Modify partially a given gartner demo","description":"Modify the gartner demo setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/gartner demo/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of gartner demo 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (es).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (es).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (es).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/gartnerdemo/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/gartnerdemo/workflow":{"get":{"summary":"Get gartner demo workflow.","description":"Returns the whole workflow tree of gartner demo resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of gartner demo","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/gartnerdemo/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given gartner demo.","description":"Returns all possible workflow actions to apply to a given gartner demo.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the gartner demo of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified gartner demo.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given gartner demo.","description":"Change the workflow state of specified gartner demo.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the gartner demo whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (gartnerdemo).","readOnly":true,"example":"gartnerdemo"},"name":{"type":"string","description":"Localized name of resource (gartner demo).","readOnly":true,"example":"gartner demo"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/gartnerdemo/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/genaitempimage":{"get":{"summary":"Find genaitempimage resources.","description":"Returns a list of genaitempimage resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"name":{"type":"string","description":"Localized name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/genaitempimage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of genaitempimage","readOnly":true,"items":{"title":"genaitempimage","description":"Data structure of resource genaitempimage.","allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new genaitempimage","description":"In this mode, you can create one new genaitempimage from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new genaitempimage to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"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_brandguideline","in":"query","description":"Identifier of brandguideline to set to property brandguideline","schema":{"type":"string"},"required":false},{"name":"prop_brandscore","in":"query","description":"Value to set to property brandscore.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_brandscoredate","in":"query","description":"Value to set to property brandscoredate.","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_brandscorereport","in":"query","description":"Value to set to property brandscorereport.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"brandguideline":{"description":"Identifier of brandguideline to set to property brandguideline","type":"string"},"brandscore":{"description":"Value to set to property brandscore.","type":"integer","format":"int32"},"brandscoredate":{"description":"Value to set to property brandscoredate.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"brandscorereport":{"description":"Value to set to property brandscorereport.","type":"string"}},"required":["name","brandguideline","brandscore","brandscoredate","brandscorereport"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"brandguideline":{"description":"Identifier of brandguideline to set to property brandguideline","type":"string"},"brandscore":{"description":"Value to set to property brandscore.","type":"integer","format":"int32"},"brandscoredate":{"description":"Value to set to property brandscoredate.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"brandscorereport":{"description":"Value to set to property brandscorereport.","type":"string"}},"required":["name","brandguideline","brandscore","brandscoredate","brandscorereport"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_brandguideline":{"description":"Identifier of brandguideline to set to property brandguideline","type":"string"},"prop_brandscore":{"description":"Value to set to property brandscore.","type":"integer","format":"int32"},"prop_brandscoredate":{"description":"Value to set to property brandscoredate.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_brandscorereport":{"description":"Value to set to property brandscorereport.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"name":{"type":"string","description":"Localized name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/genaitempimage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"name":{"type":"string","description":"Localized name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/genaitempimage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/genaitempimage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/genaitempimage/list":{"get":{"summary":"Get paginated list of genaitempimage resources.","description":"Returns a paginated list of genaitempimage resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"name":{"type":"string","description":"Localized name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/genaitempimage/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of genaitempimage","readOnly":true,"items":{"title":"genaitempimage","description":"Data structure of resource genaitempimage.","allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/genaitempimage/{resourceId}":{"get":{"summary":"Get a given genaitempimage resource.","description":"Returns a single genaitempimage resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of genaitempimage to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"name":{"type":"string","description":"Localized name of resource (genaitempimage).","readOnly":true,"example":"genaitempimage"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/genaitempimage/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested genaitempimage resource","allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/genaitempimage/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of genaitempimage resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of genaitempimage resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/assetgeography":{"get":{"summary":"Find geographical thesaurus resources.","description":"Returns a list of geographical thesaurus resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgeography).","readOnly":true,"example":"assetgeography"},"name":{"type":"string","description":"Localized name of resource (geographical thesaurus).","readOnly":true,"example":"geographical thesaurus"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgeography"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of geographical thesaurus","readOnly":true,"items":{"title":"geographical thesaurus","description":"Data structure of resource geographical thesaurus.","allOf":[{"$ref":"#/components/schemas/resource-assetgeography"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetgeography/list":{"get":{"summary":"Get paginated list of geographical thesaurus resources.","description":"Returns a paginated list of geographical thesaurus resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgeography).","readOnly":true,"example":"assetgeography"},"name":{"type":"string","description":"Localized name of resource (geographical thesaurus).","readOnly":true,"example":"geographical thesaurus"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgeography/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of geographical thesaurus","readOnly":true,"items":{"title":"geographical thesaurus","description":"Data structure of resource geographical thesaurus.","allOf":[{"$ref":"#/components/schemas/resource-assetgeography"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetgeography/tree":{"get":{"summary":"Get geographical thesaurus resources as tree.","description":"Returns a tree view of geographical thesaurus resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgeography).","readOnly":true,"example":"assetgeography"},"name":{"type":"string","description":"Localized name of resource (geographical thesaurus).","readOnly":true,"example":"geographical thesaurus"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgeography/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of geographical thesaurus","readOnly":true,"items":{"title":"geographical thesaurus","description":"Data structure of resource geographical thesaurus.","allOf":[{"$ref":"#/components/schemas/resource-assetgeography"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetgeography/{resourceId}":{"get":{"summary":"Get a given geographical thesaurus resource.","description":"Returns a single geographical thesaurus resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of geographical thesaurus to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetgeography).","readOnly":true,"example":"assetgeography"},"name":{"type":"string","description":"Localized name of resource (geographical thesaurus).","readOnly":true,"example":"geographical thesaurus"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetgeography/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested geographical thesaurus resource","allOf":[{"$ref":"#/components/schemas/resource-assetgeography"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetkeyword":{"get":{"summary":"Find keyword resources.","description":"Returns a list of keyword resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetkeyword).","readOnly":true,"example":"assetkeyword"},"name":{"type":"string","description":"Localized name of resource (keyword).","readOnly":true,"example":"keyword"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetkeyword"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of keyword","readOnly":true,"items":{"title":"keyword","description":"Data structure of resource keyword.","allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new keyword","description":"Create one new keyword setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property keyword.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property keyword.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name","namefr","namede"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property keyword.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name","namefr","namede"]},"prop_name":{"description":"Value to set to property keyword.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetkeyword).","readOnly":true,"example":"assetkeyword"},"name":{"type":"string","description":"Localized name of resource (keyword).","readOnly":true,"example":"keyword"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetkeyword"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetkeyword).","readOnly":true,"example":"assetkeyword"},"name":{"type":"string","description":"Localized name of resource (keyword).","readOnly":true,"example":"keyword"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetkeyword"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetkeyword"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetkeyword/list":{"get":{"summary":"Get paginated list of keyword resources.","description":"Returns a paginated list of keyword resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetkeyword).","readOnly":true,"example":"assetkeyword"},"name":{"type":"string","description":"Localized name of resource (keyword).","readOnly":true,"example":"keyword"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetkeyword/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of keyword","readOnly":true,"items":{"title":"keyword","description":"Data structure of resource keyword.","allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetkeyword/{resourceId}":{"get":{"summary":"Get a given keyword resource.","description":"Returns a single keyword resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of keyword to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetkeyword).","readOnly":true,"example":"assetkeyword"},"name":{"type":"string","description":"Localized name of resource (keyword).","readOnly":true,"example":"keyword"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetkeyword/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested keyword resource","allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/ailandmark":{"get":{"summary":"Find landmark resources.","description":"Returns a list of landmark resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (ailandmark).","readOnly":true,"example":"ailandmark"},"name":{"type":"string","description":"Localized name of resource (landmark).","readOnly":true,"example":"landmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/ailandmark"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of landmark","readOnly":true,"items":{"title":"landmark","description":"Data structure of resource landmark.","allOf":[{"$ref":"#/components/schemas/resource-ailandmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/ailandmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/ailandmark/list":{"get":{"summary":"Get paginated list of landmark resources.","description":"Returns a paginated list of landmark resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (ailandmark).","readOnly":true,"example":"ailandmark"},"name":{"type":"string","description":"Localized name of resource (landmark).","readOnly":true,"example":"landmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/ailandmark/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of landmark","readOnly":true,"items":{"title":"landmark","description":"Data structure of resource landmark.","allOf":[{"$ref":"#/components/schemas/resource-ailandmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/ailandmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/ailandmark/{resourceId}":{"get":{"summary":"Get a given landmark resource.","description":"Returns a single landmark resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of landmark to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (ailandmark).","readOnly":true,"example":"ailandmark"},"name":{"type":"string","description":"Localized name of resource (landmark).","readOnly":true,"example":"landmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/ailandmark/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested landmark resource","allOf":[{"$ref":"#/components/schemas/resource-ailandmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/ailandmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/lang":{"get":{"summary":"Find language resources.","description":"Returns a list of language resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (lang).","readOnly":true,"example":"lang"},"name":{"type":"string","description":"Localized name of resource (language).","readOnly":true,"example":"language"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/lang"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of language","readOnly":true,"items":{"title":"language","description":"Data structure of resource language.","allOf":[{"$ref":"#/components/schemas/resource-lang"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/lang/list":{"get":{"summary":"Get paginated list of language resources.","description":"Returns a paginated list of language resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (lang).","readOnly":true,"example":"lang"},"name":{"type":"string","description":"Localized name of resource (language).","readOnly":true,"example":"language"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/lang/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of language","readOnly":true,"items":{"title":"language","description":"Data structure of resource language.","allOf":[{"$ref":"#/components/schemas/resource-lang"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/lang/{resourceId}":{"get":{"summary":"Get a given language resource.","description":"Returns a single language resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of language to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (lang).","readOnly":true,"example":"lang"},"name":{"type":"string","description":"Localized name of resource (language).","readOnly":true,"example":"language"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/lang/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested language resource","allOf":[{"$ref":"#/components/schemas/resource-lang"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/lang/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of language resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of language resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["icon"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/assetlanguage":{"get":{"summary":"Find languages resources.","description":"Returns a list of languages resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetlanguage).","readOnly":true,"example":"assetlanguage"},"name":{"type":"string","description":"Localized name of resource (languages).","readOnly":true,"example":"languages"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetlanguage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of languages","readOnly":true,"items":{"title":"languages","description":"Data structure of resource languages.","allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new languages","description":"Create one new languages setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_code","in":"query","description":"Value to set to property code.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"code":{"description":"Value to set to property code.","type":"string"}},"required":["name","namefr","namede","code"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"code":{"description":"Value to set to property code.","type":"string"}},"required":["name","namefr","namede","code"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_code":{"description":"Value to set to property code.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetlanguage).","readOnly":true,"example":"assetlanguage"},"name":{"type":"string","description":"Localized name of resource (languages).","readOnly":true,"example":"languages"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetlanguage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetlanguage).","readOnly":true,"example":"assetlanguage"},"name":{"type":"string","description":"Localized name of resource (languages).","readOnly":true,"example":"languages"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetlanguage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetlanguage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetlanguage/list":{"get":{"summary":"Get paginated list of languages resources.","description":"Returns a paginated list of languages resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetlanguage).","readOnly":true,"example":"assetlanguage"},"name":{"type":"string","description":"Localized name of resource (languages).","readOnly":true,"example":"languages"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetlanguage/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of languages","readOnly":true,"items":{"title":"languages","description":"Data structure of resource languages.","allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetlanguage/{resourceId}":{"get":{"summary":"Get a given languages resource.","description":"Returns a single languages resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of languages to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetlanguage).","readOnly":true,"example":"assetlanguage"},"name":{"type":"string","description":"Localized name of resource (languages).","readOnly":true,"example":"languages"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetlanguage/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested languages resource","allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/legacy":{"get":{"summary":"Find legacy resources.","description":"Returns a list of legacy resources.\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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of legacy","readOnly":true,"items":{"title":"legacy","description":"Data structure of resource 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","allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new legacy","description":"In this mode, you can create one new legacy from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new legacy to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_productionyear","in":"query","description":"Value to set to property production year.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_conservationstate","in":"query","description":"Value to set to property conservation state.","schema":{"type":"string"},"required":false},{"name":"prop_dteentrycollection","in":"query","description":"Value to set to property date of entry in the collections.","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"prop_conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"prop_dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/legacy/list":{"get":{"summary":"Get paginated list of legacy resources.","description":"Returns a paginated list of legacy resources.\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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of legacy","readOnly":true,"items":{"title":"legacy","description":"Data structure of resource 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","allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/legacy/{resourceId}":{"get":{"summary":"Get a given legacy resource.","description":"Returns a single legacy resource for a resource 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":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested legacy resource","allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given legacy","description":"In this mode, you can modify the legacy from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new legacy to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_productionyear","in":"query","description":"Value to set to property production year.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_conservationstate","in":"query","description":"Value to set to property conservation state.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_dteentrycollection","in":"query","description":"Value to set to property date of entry in the collections.","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"prop_conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given legacy","description":"In this mode, you can modify the legacy from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new legacy to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_productionyear","in":"query","description":"Value to set to property production year.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_conservationstate","in":"query","description":"Value to set to property conservation state.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_dteentrycollection","in":"query","description":"Value to set to property date of entry in the collections.","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property caption (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"prop_conservationstate":{"description":"Value to set to property conservation state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given legacy","description":"Delete definitively a legacy","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/legacy/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/legacy/{resourceId}/put":{"post":{"summary":"Modify a given legacy","description":"In this mode, you can modify the legacy from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new legacy to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/legacy/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_productionyear","in":"query","description":"Value to set to property production year.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_conservationstate","in":"query","description":"Value to set to property conservation state.","schema":{"type":"string"},"required":false},{"name":"prop_dteentrycollection","in":"query","description":"Value to set to property date of entry in the collections.","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","visibility","productionyear","conservationstate","dteentrycollection","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"prop_conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"prop_dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/legacy/{resourceId}/patch":{"post":{"summary":"Modify partially a given legacy","description":"In this mode, you can modify the legacy from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new legacy to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/legacy/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property caption (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property caption (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_productionyear","in":"query","description":"Value to set to property production year.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_conservationstate","in":"query","description":"Value to set to property conservation state.","schema":{"type":"string"},"required":false},{"name":"prop_dteentrycollection","in":"query","description":"Value to set to property date of entry in the collections.","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property caption (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property caption (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_productionyear":{"description":"Value to set to property production year.","type":"integer","format":"int32"},"prop_conservationstate":{"description":"Value to set to property conservation state.","type":"string"},"prop_dteentrycollection":{"description":"Value to set to property date of entry in the collections.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/legacy/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/legacy/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of legacy resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary","poster"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/legacy/{resourceId}/$workcopy":{"get":{"summary":"Get a workcopy of a given legacy","description":"Returns a workcopy of specified legacy (create if necessary).\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":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of legacy to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The current editable version of the resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested legacy resource","allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}},"201":{"description":"A new editable version of resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested legacy resource","allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/legacy/workflow":{"get":{"summary":"Get legacy workflow.","description":"Returns the whole workflow tree of legacy resources.\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":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of legacy","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/legacy/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given legacy.","description":"Returns all possible workflow actions to apply to a given 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":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the legacy of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified legacy.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given legacy.","description":"Change the workflow state of 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":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the legacy whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (legacy).","readOnly":true,"example":"legacy"},"name":{"type":"string","description":"Localized name of resource (legacy).","readOnly":true,"example":"legacy"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/legacy/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/organization":{"get":{"summary":"Find organization resources.","description":"Returns a list of organization resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (organization).","readOnly":true,"example":"organization"},"name":{"type":"string","description":"Localized name of resource (organization).","readOnly":true,"example":"organization"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/organization"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of organization","readOnly":true,"items":{"title":"organization","description":"Data structure of resource organization.","allOf":[{"$ref":"#/components/schemas/resource-organization"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/organization/list":{"get":{"summary":"Get paginated list of organization resources.","description":"Returns a paginated list of organization resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (organization).","readOnly":true,"example":"organization"},"name":{"type":"string","description":"Localized name of resource (organization).","readOnly":true,"example":"organization"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/organization/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of organization","readOnly":true,"items":{"title":"organization","description":"Data structure of resource organization.","allOf":[{"$ref":"#/components/schemas/resource-organization"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/organization/tree":{"get":{"summary":"Get organization resources as tree.","description":"Returns a tree view of organization resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (organization).","readOnly":true,"example":"organization"},"name":{"type":"string","description":"Localized name of resource (organization).","readOnly":true,"example":"organization"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/organization/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of organization","readOnly":true,"items":{"title":"organization","description":"Data structure of resource organization.","allOf":[{"$ref":"#/components/schemas/resource-organization"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/organization/{resourceId}":{"get":{"summary":"Get a given organization resource.","description":"Returns a single organization resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of organization to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (organization).","readOnly":true,"example":"organization"},"name":{"type":"string","description":"Localized name of resource (organization).","readOnly":true,"example":"organization"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/organization/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested organization resource","allOf":[{"$ref":"#/components/schemas/resource-organization"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetformat":{"get":{"summary":"Find orientation resources.","description":"Returns a list of orientation resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetformat).","readOnly":true,"example":"assetformat"},"name":{"type":"string","description":"Localized name of resource (orientation).","readOnly":true,"example":"orientation"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetformat"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of orientation","readOnly":true,"items":{"title":"orientation","description":"Data structure of resource orientation.","allOf":[{"$ref":"#/components/schemas/resource-assetformat"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetformat/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetformat/list":{"get":{"summary":"Get paginated list of orientation resources.","description":"Returns a paginated list of orientation resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetformat).","readOnly":true,"example":"assetformat"},"name":{"type":"string","description":"Localized name of resource (orientation).","readOnly":true,"example":"orientation"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetformat/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of orientation","readOnly":true,"items":{"title":"orientation","description":"Data structure of resource orientation.","allOf":[{"$ref":"#/components/schemas/resource-assetformat"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetformat/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetformat/{resourceId}":{"get":{"summary":"Get a given orientation resource.","description":"Returns a single orientation resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of orientation to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetformat).","readOnly":true,"example":"assetformat"},"name":{"type":"string","description":"Localized name of resource (orientation).","readOnly":true,"example":"orientation"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetformat/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested orientation resource","allOf":[{"$ref":"#/components/schemas/resource-assetformat"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetformat/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetauthor":{"get":{"summary":"Find photographer resources.","description":"Returns a list of photographer resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetauthor).","readOnly":true,"example":"assetauthor"},"name":{"type":"string","description":"Localized name of resource (photographer).","readOnly":true,"example":"photographer"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetauthor"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of photographer","readOnly":true,"items":{"title":"photographer","description":"Data structure of resource photographer.","allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new photographer","description":"Create one new photographer setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":false},{"name":"prop_email","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property last name.","type":"string"},"email":{"description":"Value to set to property email.","type":"string"}},"required":["name","email"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property last name.","type":"string"},"email":{"description":"Value to set to property email.","type":"string"}},"required":["name","email"]},"prop_name":{"description":"Value to set to property last name.","type":"string"},"prop_email":{"description":"Value to set to property email.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetauthor).","readOnly":true,"example":"assetauthor"},"name":{"type":"string","description":"Localized name of resource (photographer).","readOnly":true,"example":"photographer"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetauthor"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (assetauthor).","readOnly":true,"example":"assetauthor"},"name":{"type":"string","description":"Localized name of resource (photographer).","readOnly":true,"example":"photographer"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetauthor"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/assetauthor"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/assetauthor/list":{"get":{"summary":"Get paginated list of photographer resources.","description":"Returns a paginated list of photographer resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetauthor).","readOnly":true,"example":"assetauthor"},"name":{"type":"string","description":"Localized name of resource (photographer).","readOnly":true,"example":"photographer"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetauthor/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of photographer","readOnly":true,"items":{"title":"photographer","description":"Data structure of resource photographer.","allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetauthor/{resourceId}":{"get":{"summary":"Get a given photographer resource.","description":"Returns a single photographer resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of photographer to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetauthor).","readOnly":true,"example":"assetauthor"},"name":{"type":"string","description":"Localized name of resource (photographer).","readOnly":true,"example":"photographer"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetauthor/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested photographer resource","allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/pkgassetzipdownload":{"get":{"summary":"Find pkgassetzipdownload resources.","description":"Returns a list of pkgassetzipdownload resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"name":{"type":"string","description":"Localized name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pkgassetzipdownload"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of pkgassetzipdownload","readOnly":true,"items":{"title":"pkgassetzipdownload","description":"Data structure of resource pkgassetzipdownload.","allOf":[{"$ref":"#/components/schemas/resource-pkgassetzipdownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/pkgassetzipdownload/list":{"get":{"summary":"Get paginated list of pkgassetzipdownload resources.","description":"Returns a paginated list of pkgassetzipdownload resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"name":{"type":"string","description":"Localized name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pkgassetzipdownload/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of pkgassetzipdownload","readOnly":true,"items":{"title":"pkgassetzipdownload","description":"Data structure of resource pkgassetzipdownload.","allOf":[{"$ref":"#/components/schemas/resource-pkgassetzipdownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/pkgassetzipdownload/{resourceId}":{"get":{"summary":"Get a given pkgassetzipdownload resource.","description":"Returns a single pkgassetzipdownload resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of pkgassetzipdownload to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"name":{"type":"string","description":"Localized name of resource (pkgassetzipdownload).","readOnly":true,"example":"pkgassetzipdownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pkgassetzipdownload/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested pkgassetzipdownload resource","allOf":[{"$ref":"#/components/schemas/resource-pkgassetzipdownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"delete":{"summary":"Delete a given pkgassetzipdownload","description":"Delete definitively a pkgassetzipdownload","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of pkgassetzipdownload to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/pkgassetzipdownload/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pkgassetzipdownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/portalbookmark":{"get":{"summary":"Find portalbookmark resources.","description":"Returns a list of portalbookmark resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portalbookmark"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of portalbookmark","readOnly":true,"items":{"title":"portalbookmark","description":"Data structure of resource portalbookmark.","allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new portalbookmark","description":"In this mode, you can create one new portalbookmark from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portalbookmark to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_cart","in":"query","description":"Identifier of wxmcart to set to property cart","schema":{"type":"string"},"required":false},{"name":"prop_link","in":"query","description":"Value to set to property url.","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property custom thumbnail","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_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property terms of use.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]},"prop_type":{"description":"Value to set to property type.","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"prop_link":{"description":"Value to set to property url.","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property terms of use.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portalbookmark/list":{"get":{"summary":"Get paginated list of portalbookmark resources.","description":"Returns a paginated list of portalbookmark resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portalbookmark/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of portalbookmark","readOnly":true,"items":{"title":"portalbookmark","description":"Data structure of resource portalbookmark.","allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/portalbookmark/{resourceId}":{"get":{"summary":"Get a given portalbookmark resource.","description":"Returns a single portalbookmark resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portalbookmark/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested portalbookmark resource","allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given portalbookmark","description":"In this mode, you can modify the portalbookmark from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portalbookmark to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark to get.","schema":{"type":"integer"},"required":true},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_cart","in":"query","description":"Identifier of wxmcart to set to property cart","schema":{"type":"string"},"required":false},{"name":"prop_link","in":"query","description":"Value to set to property url.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property custom thumbnail","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_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property terms of use.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]},"prop_type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"prop_link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given portalbookmark","description":"In this mode, you can modify the portalbookmark from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portalbookmark to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_cart","in":"query","description":"Identifier of wxmcart to set to property cart","schema":{"type":"string"},"required":false},{"name":"prop_link","in":"query","description":"Value to set to property url.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property custom thumbnail","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_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property terms of use.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"prop_link":{"description":"Value to set to property url.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property terms of use.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portalbookmark/{resourceId}/put":{"post":{"summary":"Modify a given portalbookmark","description":"In this mode, you can modify the portalbookmark from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portalbookmark to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/portalbookmark/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark to get.","schema":{"type":"integer"},"required":true},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_cart","in":"query","description":"Identifier of wxmcart to set to property cart","schema":{"type":"string"},"required":false},{"name":"prop_link","in":"query","description":"Value to set to property url.","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property custom thumbnail","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_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property terms of use.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}},"required":["type","name","namefr","namede","portal","cart","link","position","teamgroups","viewergroups","visibility"]},"prop_type":{"description":"Value to set to property type.","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"prop_link":{"description":"Value to set to property url.","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property terms of use.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portalbookmark/{resourceId}/patch":{"post":{"summary":"Modify partially a given portalbookmark","description":"In this mode, you can modify the portalbookmark from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portalbookmark to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/portalbookmark/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_cart","in":"query","description":"Identifier of wxmcart to set to property cart","schema":{"type":"string"},"required":false},{"name":"prop_link","in":"query","description":"Value to set to property url.","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property custom thumbnail","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_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property terms of use.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"type":{"description":"Value to set to property type.","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"link":{"description":"Value to set to property url.","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"visibility":{"description":"Value to set to property terms of use.","type":"string"}}},"prop_type":{"description":"Value to set to property type.","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_cart":{"description":"Identifier of wxmcart to set to property cart","type":"string"},"prop_link":{"description":"Value to set to property url.","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property custom thumbnail","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property terms of use.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"name":{"type":"string","description":"Localized name of resource (portalbookmark).","readOnly":true,"example":"portalbookmark"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portalbookmark/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portalbookmark/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of portalbookmark resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portalbookmark resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["logo"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/portaldownload":{"get":{"summary":"Find portaldownload resources.","description":"Returns a list of portaldownload resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"name":{"type":"string","description":"Localized name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaldownload"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of portaldownload","readOnly":true,"items":{"title":"portaldownload","description":"Data structure of resource portaldownload.","allOf":[{"$ref":"#/components/schemas/resource-portaldownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/portaldownload/list":{"get":{"summary":"Get paginated list of portaldownload resources.","description":"Returns a paginated list of portaldownload resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"name":{"type":"string","description":"Localized name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaldownload/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of portaldownload","readOnly":true,"items":{"title":"portaldownload","description":"Data structure of resource portaldownload.","allOf":[{"$ref":"#/components/schemas/resource-portaldownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/portaldownload/{resourceId}":{"get":{"summary":"Get a given portaldownload resource.","description":"Returns a single portaldownload resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaldownload to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"name":{"type":"string","description":"Localized name of resource (portaldownload).","readOnly":true,"example":"portaldownload"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaldownload/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested portaldownload resource","allOf":[{"$ref":"#/components/schemas/resource-portaldownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"delete":{"summary":"Delete a given portaldownload","description":"Delete definitively a portaldownload","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaldownload to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/portaldownload/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaldownload"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/portal":{"get":{"summary":"Find portals resources.","description":"Returns a list of portals resources.\n\n\n\n> The base structure of the portals functionality. \n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of portals","readOnly":true,"items":{"title":"portals","description":"Data structure of resource portals. \n\n\n\n> The base structure of the portals functionality. \n","allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new portals","description":"In this mode, you can create one new portals from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portals to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_state","in":"query","description":"Value to set to property state.","schema":{"type":"string"},"required":false},{"name":"prop_firstitems","in":"query","description":"Value to set to property firstitems.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_cover","in":"query","description":"Name, or URI, of the file to store in the property banner","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_descriptionhtml","in":"query","description":"HTML Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlfr","in":"query","description":"HTML Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlde","in":"query","description":"HTML Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_private","in":"query","description":"Value to set to property private.","schema":{"type":"boolean"},"required":false},{"name":"prop_newestitems","in":"query","description":"Value to set to property newestitems.","schema":{"type":"string"},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property visibility.","schema":{"type":"string"},"required":false},{"name":"prop_subtitle","in":"query","description":"Value to set to property subtitle.","schema":{"type":"string"},"required":false},{"name":"prop_subtitlefr","in":"query","description":"Value to set to property subtitle (fr).","schema":{"type":"string"},"required":false},{"name":"prop_subtitlede","in":"query","description":"Value to set to property subtitle (de).","schema":{"type":"string"},"required":false},{"name":"prop_bookmarks","in":"query","description":"Identifiers of portalbookmark to set property bookmarks","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_portaltheme","in":"query","description":"Identifier of portaltheme to set to property portal theme","schema":{"type":"string"},"required":false},{"name":"prop_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_state":{"description":"Value to set to property state.","type":"string"},"prop_firstitems":{"description":"Value to set to property firstitems.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"prop_descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"prop_descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"prop_private":{"description":"Value to set to property private.","type":"boolean"},"prop_newestitems":{"description":"Value to set to property newestitems.","type":"string"},"prop_visibility":{"description":"Value to set to property visibility.","type":"string"},"prop_subtitle":{"description":"Value to set to property subtitle.","type":"string"},"prop_subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"prop_subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"prop_bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portal/list":{"get":{"summary":"Get paginated list of portals resources.","description":"Returns a paginated list of portals resources.\n\n\n\n> The base structure of the portals functionality. \n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of portals","readOnly":true,"items":{"title":"portals","description":"Data structure of resource portals. \n\n\n\n> The base structure of the portals functionality. \n","allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/portal/tree":{"get":{"summary":"Get portals resources as tree.","description":"Returns a tree view of portals resources.\n\n\n\n> The base structure of the portals functionality. \n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of portals","readOnly":true,"items":{"title":"portals","description":"Data structure of resource portals. \n\n\n\n> The base structure of the portals functionality. \n","allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/portal/{resourceId}":{"get":{"summary":"Get a given portals resource.","description":"Returns a single portals resource for a resource id.\n\n\n\n> The base structure of the portals functionality. \n","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested portals resource","allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given portals","description":"In this mode, you can modify the portals from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portals to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_state","in":"query","description":"Value to set to property state.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_firstitems","in":"query","description":"Value to set to property firstitems.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_cover","in":"query","description":"Name, or URI, of the file to store in the property banner","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_descriptionhtml","in":"query","description":"HTML Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlfr","in":"query","description":"HTML Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlde","in":"query","description":"HTML Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_private","in":"query","description":"Value to set to property private.","schema":{"type":"boolean"},"required":false},{"name":"prop_newestitems","in":"query","description":"Value to set to property newestitems.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property visibility.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitle","in":"query","description":"Value to set to property subtitle.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitlefr","in":"query","description":"Value to set to property subtitle (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitlede","in":"query","description":"Value to set to property subtitle (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_bookmarks","in":"query","description":"Identifiers of portalbookmark to set property bookmarks","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_portaltheme","in":"query","description":"Identifier of portaltheme to set to property portal theme","schema":{"type":"string"},"required":false},{"name":"prop_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"prop_descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"prop_descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"prop_private":{"description":"Value to set to property private.","type":"boolean"},"prop_newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given portals","description":"In this mode, you can modify the portals from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portals to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_state","in":"query","description":"Value to set to property state.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_firstitems","in":"query","description":"Value to set to property firstitems.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_cover","in":"query","description":"Name, or URI, of the file to store in the property banner","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_descriptionhtml","in":"query","description":"HTML Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlfr","in":"query","description":"HTML Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlde","in":"query","description":"HTML Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_private","in":"query","description":"Value to set to property private.","schema":{"type":"boolean"},"required":false},{"name":"prop_newestitems","in":"query","description":"Value to set to property newestitems.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property visibility.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitle","in":"query","description":"Value to set to property subtitle.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitlefr","in":"query","description":"Value to set to property subtitle (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_subtitlede","in":"query","description":"Value to set to property subtitle (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_bookmarks","in":"query","description":"Identifiers of portalbookmark to set property bookmarks","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_portaltheme","in":"query","description":"Identifier of portaltheme to set to property portal theme","schema":{"type":"string"},"required":false},{"name":"prop_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_state":{"description":"Value to set to property state.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_firstitems":{"description":"Value to set to property firstitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"prop_descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"prop_descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"prop_private":{"description":"Value to set to property private.","type":"boolean"},"prop_newestitems":{"description":"Value to set to property newestitems.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_visibility":{"description":"Value to set to property visibility.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitle":{"description":"Value to set to property subtitle.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitlefr":{"description":"Value to set to property subtitle (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_subtitlede":{"description":"Value to set to property subtitle (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given portals","description":"Delete definitively a portals","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/portal/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/portal/{resourceId}/put":{"post":{"summary":"Modify a given portals","description":"In this mode, you can modify the portals from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portals to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/portals/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_state","in":"query","description":"Value to set to property state.","schema":{"type":"string"},"required":false},{"name":"prop_firstitems","in":"query","description":"Value to set to property firstitems.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_cover","in":"query","description":"Name, or URI, of the file to store in the property banner","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_descriptionhtml","in":"query","description":"HTML Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlfr","in":"query","description":"HTML Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlde","in":"query","description":"HTML Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_private","in":"query","description":"Value to set to property private.","schema":{"type":"boolean"},"required":false},{"name":"prop_newestitems","in":"query","description":"Value to set to property newestitems.","schema":{"type":"string"},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property visibility.","schema":{"type":"string"},"required":false},{"name":"prop_subtitle","in":"query","description":"Value to set to property subtitle.","schema":{"type":"string"},"required":false},{"name":"prop_subtitlefr","in":"query","description":"Value to set to property subtitle (fr).","schema":{"type":"string"},"required":false},{"name":"prop_subtitlede","in":"query","description":"Value to set to property subtitle (de).","schema":{"type":"string"},"required":false},{"name":"prop_bookmarks","in":"query","description":"Identifiers of portalbookmark to set property bookmarks","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_portaltheme","in":"query","description":"Identifier of portaltheme to set to property portal theme","schema":{"type":"string"},"required":false},{"name":"prop_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_state":{"description":"Value to set to property state.","type":"string"},"prop_firstitems":{"description":"Value to set to property firstitems.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"prop_descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"prop_descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"prop_private":{"description":"Value to set to property private.","type":"boolean"},"prop_newestitems":{"description":"Value to set to property newestitems.","type":"string"},"prop_visibility":{"description":"Value to set to property visibility.","type":"string"},"prop_subtitle":{"description":"Value to set to property subtitle.","type":"string"},"prop_subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"prop_subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"prop_bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portal/{resourceId}/patch":{"post":{"summary":"Modify partially a given portals","description":"In this mode, you can modify the portals from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portals to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/portals/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals 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_portal","in":"query","description":"Identifier of portals to set to property portal","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_position","in":"query","description":"Value to set to property position.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_state","in":"query","description":"Value to set to property state.","schema":{"type":"string"},"required":false},{"name":"prop_firstitems","in":"query","description":"Value to set to property firstitems.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_logo","in":"query","description":"Name, or URI, of the file to store in the property logo","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_cover","in":"query","description":"Name, or URI, of the file to store in the property banner","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_descriptionhtml","in":"query","description":"HTML Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlfr","in":"query","description":"HTML Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionhtmlde","in":"query","description":"HTML Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_private","in":"query","description":"Value to set to property private.","schema":{"type":"boolean"},"required":false},{"name":"prop_newestitems","in":"query","description":"Value to set to property newestitems.","schema":{"type":"string"},"required":false},{"name":"prop_visibility","in":"query","description":"Value to set to property visibility.","schema":{"type":"string"},"required":false},{"name":"prop_subtitle","in":"query","description":"Value to set to property subtitle.","schema":{"type":"string"},"required":false},{"name":"prop_subtitlefr","in":"query","description":"Value to set to property subtitle (fr).","schema":{"type":"string"},"required":false},{"name":"prop_subtitlede","in":"query","description":"Value to set to property subtitle (de).","schema":{"type":"string"},"required":false},{"name":"prop_bookmarks","in":"query","description":"Identifiers of portalbookmark to set property bookmarks","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_portaltheme","in":"query","description":"Identifier of portaltheme to set to property portal theme","schema":{"type":"string"},"required":false},{"name":"prop_teamgroups","in":"query","description":"Identifiers of usergroup to set property teamgroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewergroups","in":"query","description":"Identifiers of usergroup to set property viewergroups","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_logo by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"portal":{"description":"Identifier of portals to set to property portal","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"state":{"description":"Value to set to property state.","type":"string"},"firstitems":{"description":"Value to set to property firstitems.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"private":{"description":"Value to set to property private.","type":"boolean"},"newestitems":{"description":"Value to set to property newestitems.","type":"string"},"visibility":{"description":"Value to set to property visibility.","type":"string"},"subtitle":{"description":"Value to set to property subtitle.","type":"string"},"subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_portal":{"description":"Identifier of portals to set to property portal","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_position":{"description":"Value to set to property position.","type":"integer","format":"int32"},"prop_state":{"description":"Value to set to property state.","type":"string"},"prop_firstitems":{"description":"Value to set to property firstitems.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_logo":{"description":"Name, URI of the file or binary content to store in the property logo","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_cover":{"description":"Name, URI of the file or binary content to store in the property banner","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_descriptionhtml":{"description":"HTML Value to set to property description.","type":"string"},"prop_descriptionhtmlfr":{"description":"HTML Value to set to property description (fr).","type":"string"},"prop_descriptionhtmlde":{"description":"HTML Value to set to property description (de).","type":"string"},"prop_private":{"description":"Value to set to property private.","type":"boolean"},"prop_newestitems":{"description":"Value to set to property newestitems.","type":"string"},"prop_visibility":{"description":"Value to set to property visibility.","type":"string"},"prop_subtitle":{"description":"Value to set to property subtitle.","type":"string"},"prop_subtitlefr":{"description":"Value to set to property subtitle (fr).","type":"string"},"prop_subtitlede":{"description":"Value to set to property subtitle (de).","type":"string"},"prop_bookmarks":{"description":"Identifiers of portalbookmark to set property bookmarks","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of portalbookmark."},{"type":"integer","format":"int32","description":"ID of portalbookmark."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_portaltheme":{"description":"Identifier of portaltheme to set to property portal theme","type":"string"},"prop_teamgroups":{"description":"Identifiers of usergroup to set property teamgroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewergroups":{"description":"Identifiers of usergroup to set property viewergroups","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of usergroup."},{"type":"integer","format":"int32","description":"ID of usergroup."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portal/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portal/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of portals resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portals resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["cover","logo"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/portal/workflow":{"get":{"summary":"Get portals workflow.","description":"Returns the whole workflow tree of portals resources.\n\n\n\n> The base structure of the portals functionality. \n","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of portals","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/portal/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given portals.","description":"Returns all possible workflow actions to apply to a given portals.\n\n\n\n> The base structure of the portals functionality. \n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the portals of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified portals.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given portals.","description":"Change the workflow state of specified portals.\n\n\n\n> The base structure of the portals functionality. \n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the portals whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portal).","readOnly":true,"example":"portal"},"name":{"type":"string","description":"Localized name of resource (portals).","readOnly":true,"example":"portals"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portal/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/portaltheme":{"get":{"summary":"Find portaltheme resources.","description":"Returns a list of portaltheme resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaltheme"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of portaltheme","readOnly":true,"items":{"title":"portaltheme","description":"Data structure of resource portaltheme.","allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new portaltheme","description":"In this mode, you can create one new portaltheme from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portaltheme to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_favicon","in":"query","description":"Name, or URI, of the file to store in the property favicon","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_props","in":"query","description":"Value to set to property props.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_favicon by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_props":{"description":"Value to set to property props.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portaltheme/list":{"get":{"summary":"Get paginated list of portaltheme resources.","description":"Returns a paginated list of portaltheme resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaltheme/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of portaltheme","readOnly":true,"items":{"title":"portaltheme","description":"Data structure of resource portaltheme.","allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/portaltheme/{resourceId}":{"get":{"summary":"Get a given portaltheme resource.","description":"Returns a single portaltheme resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/portaltheme/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested portaltheme resource","allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given portaltheme","description":"In this mode, you can modify the portaltheme from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portaltheme to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_favicon","in":"query","description":"Name, or URI, of the file to store in the property favicon","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_props","in":"query","description":"Value to set to property props.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_favicon by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given portaltheme","description":"In this mode, you can modify the portaltheme from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portaltheme to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_favicon","in":"query","description":"Name, or URI, of the file to store in the property favicon","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_props","in":"query","description":"Value to set to property props.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_favicon by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_props":{"description":"Value to set to property props.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given portaltheme","description":"Delete definitively a portaltheme","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/portaltheme/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/portaltheme/{resourceId}/put":{"post":{"summary":"Modify a given portaltheme","description":"In this mode, you can modify the portaltheme from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portaltheme to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/portaltheme/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_favicon","in":"query","description":"Name, or URI, of the file to store in the property favicon","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_props","in":"query","description":"Value to set to property props.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_favicon by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_props":{"description":"Value to set to property props.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portaltheme/{resourceId}/patch":{"post":{"summary":"Modify partially a given portaltheme","description":"In this mode, you can modify the portaltheme from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new portaltheme to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/portaltheme/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme 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_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_favicon","in":"query","description":"Name, or URI, of the file to store in the property favicon","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_props","in":"query","description":"Value to set to property props.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_favicon by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"props":{"description":"Value to set to property props.","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_favicon":{"description":"Name, URI of the file or binary content to store in the property favicon","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_props":{"description":"Value to set to property props.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"name":{"type":"string","description":"Localized name of resource (portaltheme).","readOnly":true,"example":"portaltheme"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/portaltheme/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/portaltheme/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of portaltheme resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of portaltheme resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["favicon"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/product":{"get":{"summary":"Find product resources.","description":"Returns a list of product resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/product"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of product","readOnly":true,"items":{"title":"product","description":"Data structure of resource product.","allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/product/list":{"get":{"summary":"Get paginated list of product resources.","description":"Returns a paginated list of product resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/product/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of product","readOnly":true,"items":{"title":"product","description":"Data structure of resource product.","allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/product/{resourceId}":{"get":{"summary":"Get a given product resource.","description":"Returns a single product resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/product/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product resource","allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given product","description":"Modify the product setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_release_date","in":"query","description":"Value to set to property delivery 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_sku","in":"query","description":"Value to set to property sku.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_productcategory","in":"query","description":"Identifier of product category to set to property product category","schema":{"type":"string"},"required":false},{"name":"prop_hero","in":"query","description":"Identifier of product asset to set to property hero image","schema":{"type":"string"},"required":false},{"name":"prop_assets","in":"query","description":"Identifiers of product asset to set property assets","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}},"required":["name","description","release_date","sku","productcategory","hero","assets","organization"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}},"required":["name","description","release_date","sku","productcategory","hero","assets","organization"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"prop_hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"prop_assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given product","description":"Modify the product setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_release_date","in":"query","description":"Value to set to property delivery 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_sku","in":"query","description":"Value to set to property sku.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_productcategory","in":"query","description":"Identifier of product category to set to property product category","schema":{"type":"string"},"required":false},{"name":"prop_hero","in":"query","description":"Identifier of product asset to set to property hero image","schema":{"type":"string"},"required":false},{"name":"prop_assets","in":"query","description":"Identifiers of product asset to set property assets","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_sku":{"description":"Value to set to property sku.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"prop_hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"prop_assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/product/{resourceId}/put":{"post":{"summary":"Modify a given product","description":"Modify the product setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/product/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product to get.","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},{"name":"prop_release_date","in":"query","description":"Value to set to property delivery 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_sku","in":"query","description":"Value to set to property sku.","schema":{"type":"string"},"required":false},{"name":"prop_productcategory","in":"query","description":"Identifier of product category to set to property product category","schema":{"type":"string"},"required":false},{"name":"prop_hero","in":"query","description":"Identifier of product asset to set to property hero image","schema":{"type":"string"},"required":false},{"name":"prop_assets","in":"query","description":"Identifiers of product asset to set property assets","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","type":"string"},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}},"required":["name","description","release_date","sku","productcategory","hero","assets","organization"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","type":"string"},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}},"required":["name","description","release_date","sku","productcategory","hero","assets","organization"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_sku":{"description":"Value to set to property sku.","type":"string"},"prop_productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"prop_hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"prop_assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/product/{resourceId}/patch":{"post":{"summary":"Modify partially a given product","description":"Modify the product setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/product/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product 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},{"name":"prop_release_date","in":"query","description":"Value to set to property delivery 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_sku","in":"query","description":"Value to set to property sku.","schema":{"type":"string"},"required":false},{"name":"prop_productcategory","in":"query","description":"Identifier of product category to set to property product category","schema":{"type":"string"},"required":false},{"name":"prop_hero","in":"query","description":"Identifier of product asset to set to property hero image","schema":{"type":"string"},"required":false},{"name":"prop_assets","in":"query","description":"Identifiers of product asset to set property assets","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","type":"string"},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"sku":{"description":"Value to set to property sku.","type":"string"},"productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_release_date":{"description":"Value to set to property delivery date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_sku":{"description":"Value to set to property sku.","type":"string"},"prop_productcategory":{"description":"Identifier of product category to set to property product category","type":"string"},"prop_hero":{"description":"Identifier of product asset to set to property hero image","type":"string"},"prop_assets":{"description":"Identifiers of product asset to set property assets","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Product Asset."},{"type":"integer","format":"int32","description":"ID of Product Asset."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (product).","readOnly":true,"example":"product"},"name":{"type":"string","description":"Localized name of resource (product).","readOnly":true,"example":"product"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/product/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/pimasset":{"get":{"summary":"Find product asset resources.","description":"Returns a list of product asset resources.\n\n\n\n> Product asset for 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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of product asset","readOnly":true,"items":{"title":"product asset","description":"Data structure of resource product asset. \n\n\n\n> Product asset for 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","allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new product asset","description":"In this mode, you can create one new product asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new product asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_productassettype","in":"query","description":"Identifier of product asset type to set to property asset type","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_season":{"description":"Identifier of season to set to property season","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/pimasset/list":{"get":{"summary":"Get paginated list of product asset resources.","description":"Returns a paginated list of product asset resources.\n\n\n\n> Product asset for 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":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of product asset","readOnly":true,"items":{"title":"product asset","description":"Data structure of resource product asset. \n\n\n\n> Product asset for 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","allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/pimasset/{resourceId}":{"get":{"summary":"Get a given product asset resource.","description":"Returns a single product asset resource for a resource id.\n\n\n\n> Product asset for 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":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product asset resource","allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given product asset","description":"In this mode, you can modify the product asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new product asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_productassettype","in":"query","description":"Identifier of product asset type to set to property asset type","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","schema":{"type":"string"},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_season":{"description":"Identifier of season to set to property season","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given product asset","description":"In this mode, you can modify the product asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new product asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_productassettype","in":"query","description":"Identifier of product asset type to set to property asset type","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","schema":{"type":"string"},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property caption.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_season":{"description":"Identifier of season to set to property season","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given product asset","description":"Delete definitively a product asset","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/pimasset/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/pimasset/{resourceId}/put":{"post":{"summary":"Modify a given product asset","description":"In this mode, you can modify the product asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new product asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/product asset/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset to get.","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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_productassettype","in":"query","description":"Identifier of product asset type to set to property asset type","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["rekousers","productassettype","season","visibility","grouping","groupingmaster","binaryorigin","focus_point_x","focus_point_y","alloweddomains"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_season":{"description":"Identifier of season to set to property season","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/pimasset/{resourceId}/patch":{"post":{"summary":"Modify partially a given product asset","description":"In this mode, you can modify the product asset from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new product asset to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/product asset/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset 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_rekousers","in":"query","description":"Identifiers of rekouser to set property rekousers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_productassettype","in":"query","description":"Identifier of product asset type to set to property asset type","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_organization","in":"query","description":"Identifier of organization to set to property organization","schema":{"type":"string"},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","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_shootingdate","in":"query","description":"Value to set to property shooting 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_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_visibility","in":"query","description":"Identifier of asset visibility to set to property terms of use","schema":{"type":"string"},"required":false},{"name":"prop_displayweight","in":"query","description":"Value to set to property featured assets.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"prop_poster","in":"query","description":"Name, or URI, of the file to store in the property poster","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_grouping","in":"query","description":"Identifier of assetgrouping to set to property grouping","schema":{"type":"string"},"required":false},{"name":"prop_groupingmaster","in":"query","description":"Value to set to property groupingmaster.","schema":{"type":"boolean"},"required":false},{"name":"prop_binaryorigin","in":"query","description":"Value to set to property binaryorigin.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_x","in":"query","description":"Value to set to property focus_point_x.","schema":{"type":"string"},"required":false},{"name":"prop_focus_point_y","in":"query","description":"Value to set to property focus_point_y.","schema":{"type":"string"},"required":false},{"name":"prop_alloweddomains","in":"query","description":"Identifiers of cspsource to set property domain names authorized for streaming","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\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.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"description":{"description":"Value to set to property caption.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"organization":{"description":"Identifier of organization to set to property organization","type":"string"},"authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"season":{"description":"Identifier of season to set to property season","type":"string"},"copyright":{"description":"Value to set to property copyright.","type":"string"},"righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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"},"visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}},"required":["visibility"]},"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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_rekousers":{"description":"Identifiers of rekouser to set property rekousers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of rekouser."},{"type":"integer","format":"int32","description":"ID of rekouser."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_productassettype":{"description":"Identifier of product asset type to set to property asset type","type":"string"},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_organization":{"description":"Identifier of organization to set to property organization","type":"string"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_season":{"description":"Identifier of season to set to property season","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_shootingdate":{"description":"Value to set to property shooting date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"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_visibility":{"description":"Identifier of asset visibility to set to property terms of use","type":"string"},"prop_displayweight":{"description":"Value to set to property featured assets.","type":"integer","format":"int32"},"prop_poster":{"description":"Name, URI of the file or binary content to store in the property poster","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2},"prop_grouping":{"description":"Identifier of assetgrouping to set to property grouping","type":"string"},"prop_groupingmaster":{"description":"Value to set to property groupingmaster.","type":"boolean"},"prop_binaryorigin":{"description":"Value to set to property binaryorigin.","type":"string"},"prop_focus_point_x":{"description":"Value to set to property focus_point_x.","type":"string"},"prop_focus_point_y":{"description":"Value to set to property focus_point_y.","type":"string"},"prop_alloweddomains":{"description":"Identifiers of cspsource to set property domain names authorized for streaming","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of cspsource."},{"type":"integer","format":"int32","description":"ID of cspsource."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/pimasset/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/pimasset/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of product asset resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["binary","source","poster"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/pimasset/{resourceId}/$workcopy":{"get":{"summary":"Get a workcopy of a given product asset","description":"Returns a workcopy of specified product asset (create if necessary).\n\n\n\n> Product asset for 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":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The current editable version of the resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product asset resource","allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}},"201":{"description":"A new editable version of resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/123/%24workcopy"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product asset resource","allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/pimasset/workflow":{"get":{"summary":"Get product asset workflow.","description":"Returns the whole workflow tree of product asset resources.\n\n\n\n> Product asset for 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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of product asset","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/pimasset/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given product asset.","description":"Returns all possible workflow actions to apply to a given product asset.\n\n\n\n> Product asset for 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 product asset of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified product asset.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given product asset.","description":"Change the workflow state of specified product asset.\n\n\n\n> Product asset for 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 product asset whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (pimasset).","readOnly":true,"example":"pimasset"},"name":{"type":"string","description":"Localized name of resource (product asset).","readOnly":true,"example":"product asset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimasset/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/pimassettype":{"get":{"summary":"Find product asset type resources.","description":"Returns a list of product asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimassettype).","readOnly":true,"example":"pimassettype"},"name":{"type":"string","description":"Localized name of resource (product asset type).","readOnly":true,"example":"product asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimassettype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of product asset type","readOnly":true,"items":{"title":"product asset type","description":"Data structure of resource product asset type.","allOf":[{"$ref":"#/components/schemas/resource-pimassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/pimassettype/list":{"get":{"summary":"Get paginated list of product asset type resources.","description":"Returns a paginated list of product asset type resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimassettype).","readOnly":true,"example":"pimassettype"},"name":{"type":"string","description":"Localized name of resource (product asset type).","readOnly":true,"example":"product asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimassettype/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of product asset type","readOnly":true,"items":{"title":"product asset type","description":"Data structure of resource product asset type.","allOf":[{"$ref":"#/components/schemas/resource-pimassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/pimassettype/{resourceId}":{"get":{"summary":"Get a given product asset type resource.","description":"Returns a single product asset type resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product asset type to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (pimassettype).","readOnly":true,"example":"pimassettype"},"name":{"type":"string","description":"Localized name of resource (product asset type).","readOnly":true,"example":"product asset type"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/pimassettype/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product asset type resource","allOf":[{"$ref":"#/components/schemas/resource-pimassettype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/productcategory":{"get":{"summary":"Find product category resources.","description":"Returns a list of product category resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (productcategory).","readOnly":true,"example":"productcategory"},"name":{"type":"string","description":"Localized name of resource (product category).","readOnly":true,"example":"product category"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/productcategory"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of product category","readOnly":true,"items":{"title":"product category","description":"Data structure of resource product category.","allOf":[{"$ref":"#/components/schemas/resource-productcategory"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/productcategory/list":{"get":{"summary":"Get paginated list of product category resources.","description":"Returns a paginated list of product category resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (productcategory).","readOnly":true,"example":"productcategory"},"name":{"type":"string","description":"Localized name of resource (product category).","readOnly":true,"example":"product category"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/productcategory/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of product category","readOnly":true,"items":{"title":"product category","description":"Data structure of resource product category.","allOf":[{"$ref":"#/components/schemas/resource-productcategory"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/productcategory/tree":{"get":{"summary":"Get product category resources as tree.","description":"Returns a tree view of product category resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (productcategory).","readOnly":true,"example":"productcategory"},"name":{"type":"string","description":"Localized name of resource (product category).","readOnly":true,"example":"product category"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/productcategory/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of product category","readOnly":true,"items":{"title":"product category","description":"Data structure of resource product category.","allOf":[{"$ref":"#/components/schemas/resource-productcategory"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/productcategory/{resourceId}":{"get":{"summary":"Get a given product category resource.","description":"Returns a single product category resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of product category to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (productcategory).","readOnly":true,"example":"productcategory"},"name":{"type":"string","description":"Localized name of resource (product category).","readOnly":true,"example":"product category"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/productcategory/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested product category resource","allOf":[{"$ref":"#/components/schemas/resource-productcategory"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/rekouser":{"get":{"summary":"Find rekouser resources.","description":"Returns a list of rekouser resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/rekouser"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of rekouser","readOnly":true,"items":{"title":"rekouser","description":"Data structure of resource rekouser.","allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new rekouser","description":"In this mode, you can create one new rekouser from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). You can also upload an archive file (zip) to create sevaral resource from archive entries. Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new rekouser to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_rekouserid","in":"query","description":"Value to set to property rekouserid.","schema":{"type":"string"},"required":false},{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"type":"string"},"required":false},{"name":"prop_avatar","in":"query","description":"Name, or URI, of the file to store in the property avatar","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":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_avatar by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"prop_firstname":{"description":"Value to set to property first name.","type":"string"},"prop_avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/rekouser/list":{"get":{"summary":"Get paginated list of rekouser resources.","description":"Returns a paginated list of rekouser resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/rekouser/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of rekouser","readOnly":true,"items":{"title":"rekouser","description":"Data structure of resource rekouser.","allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/rekouser/{resourceId}":{"get":{"summary":"Get a given rekouser resource.","description":"Returns a single rekouser resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/rekouser/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested rekouser resource","allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given rekouser","description":"In this mode, you can modify the rekouser from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new rekouser to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_rekouserid","in":"query","description":"Value to set to property rekouserid.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_avatar","in":"query","description":"Name, or URI, of the file to store in the property avatar","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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_avatar by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given rekouser","description":"In this mode, you can modify the rekouser from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new rekouser to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_rekouserid","in":"query","description":"Value to set to property rekouserid.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_avatar","in":"query","description":"Name, or URI, of the file to store in the property avatar","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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_avatar by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["rekouserid"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["rekouserid"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_rekouserid":{"description":"Value to set to property rekouserid.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_firstname":{"description":"Value to set to property first name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/rekouser/{resourceId}/put":{"post":{"summary":"Modify a given rekouser","description":"In this mode, you can modify the rekouser from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new rekouser to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/rekouser/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_rekouserid","in":"query","description":"Value to set to property rekouserid.","schema":{"type":"string"},"required":false},{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"type":"string"},"required":false},{"name":"prop_avatar","in":"query","description":"Name, or URI, of the file to store in the property avatar","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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_avatar by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["name","rekouserid","firstname"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"prop_firstname":{"description":"Value to set to property first name.","type":"string"},"prop_avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/rekouser/{resourceId}/patch":{"post":{"summary":"Modify partially a given rekouser","description":"In this mode, you can modify the rekouser from content that will be considered binary, or indicate the properties of the object by a json, or using multipart/form-data (properties can also be set in query). Specify in the header Content-Type a binary type (this type will not be used to establish the file type, so you can put application/byte-stream, or anything else, except application/json, which is reserved to indicate the data of the new rekouser to be created, in the form of json object). It is required to specify a file name: it will be used to name the file in the server and to determine the type (its suffix, or extension, is therefore essential). See details of passing properties below.\n\n> ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-date, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/rekouser/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser 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_rekouserid","in":"query","description":"Value to set to property rekouserid.","schema":{"type":"string"},"required":false},{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"type":"string"},"required":false},{"name":"prop_avatar","in":"query","description":"Name, or URI, of the file to store in the property avatar","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":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"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 body as json, within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_avatar by example), as the stored mimetype is always determined using the filename suffix.\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["rekouserid"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"firstname":{"description":"Value to set to property first name.","type":"string"},"avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"minItems":1,"maxItems":2}},"required":["rekouserid"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_rekouserid":{"description":"Value to set to property rekouserid.","type":"string"},"prop_firstname":{"description":"Value to set to property first name.","type":"string"},"prop_avatar":{"description":"Name, URI of the file or binary content to store in the property avatar","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. Possible protocols:\n\n* http/https: if domain is allowed (ask to administrators).\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}]},{"type":"object","properties":{"name":{"type":"string","description":"name of the file"},"file":{"type":"string","format":"uri","description":"URI of file. Possible protocols:\n\n* http/https: if domain is allowed and not secured.\n* file: relative to san, if allowed\n* cid: references a binary content type field name in multipart/form-data."}}}]},"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (rekouser).","readOnly":true,"example":"rekouser"},"name":{"type":"string","description":"Localized name of resource (rekouser).","readOnly":true,"example":"rekouser"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/rekouser/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/rekouser/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of rekouser resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rekouser resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["avatar"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/resolution":{"get":{"summary":"Find resolution resources.","description":"Returns a list of resolution resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (resolution).","readOnly":true,"example":"resolution"},"name":{"type":"string","description":"Localized name of resource (resolution).","readOnly":true,"example":"resolution"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/resolution"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of resolution","readOnly":true,"items":{"title":"resolution","description":"Data structure of resource resolution.","allOf":[{"$ref":"#/components/schemas/resource-resolution"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/resolution/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/resolution/list":{"get":{"summary":"Get paginated list of resolution resources.","description":"Returns a paginated list of resolution resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (resolution).","readOnly":true,"example":"resolution"},"name":{"type":"string","description":"Localized name of resource (resolution).","readOnly":true,"example":"resolution"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/resolution/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of resolution","readOnly":true,"items":{"title":"resolution","description":"Data structure of resource resolution.","allOf":[{"$ref":"#/components/schemas/resource-resolution"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/resolution/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/resolution/{resourceId}":{"get":{"summary":"Get a given resolution resource.","description":"Returns a single resolution resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of resolution to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (resolution).","readOnly":true,"example":"resolution"},"name":{"type":"string","description":"Localized name of resource (resolution).","readOnly":true,"example":"resolution"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/resolution/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested resolution resource","allOf":[{"$ref":"#/components/schemas/resource-resolution"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/resolution/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/reversesearch":{"get":{"summary":"Find reverse search resources.","description":"Returns a list of reverse search resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearch).","readOnly":true,"example":"reversesearch"},"name":{"type":"string","description":"Localized name of resource (reverse search).","readOnly":true,"example":"reverse search"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of reverse search","readOnly":true,"items":{"title":"reverse search","description":"Data structure of resource reverse search.","allOf":[{"$ref":"#/components/schemas/resource-reversesearch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/reversesearch/list":{"get":{"summary":"Get paginated list of reverse search resources.","description":"Returns a paginated list of reverse search resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearch).","readOnly":true,"example":"reversesearch"},"name":{"type":"string","description":"Localized name of resource (reverse search).","readOnly":true,"example":"reverse search"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearch/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of reverse search","readOnly":true,"items":{"title":"reverse search","description":"Data structure of resource reverse search.","allOf":[{"$ref":"#/components/schemas/resource-reversesearch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/reversesearch/{resourceId}":{"get":{"summary":"Get a given reverse search resource.","description":"Returns a single reverse search resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearch).","readOnly":true,"example":"reversesearch"},"name":{"type":"string","description":"Localized name of resource (reverse search).","readOnly":true,"example":"reverse search"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearch/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested reverse search resource","allOf":[{"$ref":"#/components/schemas/resource-reversesearch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/reversesearchdomain":{"get":{"summary":"Find reverse search domain resources.","description":"Returns a list of reverse search domain resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchdomain).","readOnly":true,"example":"reversesearchdomain"},"name":{"type":"string","description":"Localized name of resource (reverse search domain).","readOnly":true,"example":"reverse search domain"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchdomain"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of reverse search domain","readOnly":true,"items":{"title":"reverse search domain","description":"Data structure of resource reverse search domain.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchdomain"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/reversesearchdomain/list":{"get":{"summary":"Get paginated list of reverse search domain resources.","description":"Returns a paginated list of reverse search domain resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchdomain).","readOnly":true,"example":"reversesearchdomain"},"name":{"type":"string","description":"Localized name of resource (reverse search domain).","readOnly":true,"example":"reverse search domain"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchdomain/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of reverse search domain","readOnly":true,"items":{"title":"reverse search domain","description":"Data structure of resource reverse search domain.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchdomain"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/reversesearchdomain/{resourceId}":{"get":{"summary":"Get a given reverse search domain resource.","description":"Returns a single reverse search domain resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search domain to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchdomain).","readOnly":true,"example":"reversesearchdomain"},"name":{"type":"string","description":"Localized name of resource (reverse search domain).","readOnly":true,"example":"reverse search domain"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchdomain/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested reverse search domain resource","allOf":[{"$ref":"#/components/schemas/resource-reversesearchdomain"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/reversesearchdomain/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of reverse search domain resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search domain resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["preview"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/reversesearchmatch":{"get":{"summary":"Find reverse search match resources.","description":"Returns a list of reverse search match resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchmatch).","readOnly":true,"example":"reversesearchmatch"},"name":{"type":"string","description":"Localized name of resource (reverse search match).","readOnly":true,"example":"reverse search match"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchmatch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of reverse search match","readOnly":true,"items":{"title":"reverse search match","description":"Data structure of resource reverse search match.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchmatch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/reversesearchmatch/list":{"get":{"summary":"Get paginated list of reverse search match resources.","description":"Returns a paginated list of reverse search match resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchmatch).","readOnly":true,"example":"reversesearchmatch"},"name":{"type":"string","description":"Localized name of resource (reverse search match).","readOnly":true,"example":"reverse search match"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchmatch/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of reverse search match","readOnly":true,"items":{"title":"reverse search match","description":"Data structure of resource reverse search match.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchmatch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/reversesearchmatch/{resourceId}":{"get":{"summary":"Get a given reverse search match resource.","description":"Returns a single reverse search match resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search match to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchmatch).","readOnly":true,"example":"reversesearchmatch"},"name":{"type":"string","description":"Localized name of resource (reverse search match).","readOnly":true,"example":"reverse search match"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchmatch/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested reverse search match resource","allOf":[{"$ref":"#/components/schemas/resource-reversesearchmatch"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/reversesearchmatch/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of reverse search match resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search match resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["preview"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/reversesearchpage":{"get":{"summary":"Find reverse search page resources.","description":"Returns a list of reverse search page resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchpage).","readOnly":true,"example":"reversesearchpage"},"name":{"type":"string","description":"Localized name of resource (reverse search page).","readOnly":true,"example":"reverse search page"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchpage"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of reverse search page","readOnly":true,"items":{"title":"reverse search page","description":"Data structure of resource reverse search page.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchpage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchpage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/reversesearchpage/list":{"get":{"summary":"Get paginated list of reverse search page resources.","description":"Returns a paginated list of reverse search page resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchpage).","readOnly":true,"example":"reversesearchpage"},"name":{"type":"string","description":"Localized name of resource (reverse search page).","readOnly":true,"example":"reverse search page"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchpage/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of reverse search page","readOnly":true,"items":{"title":"reverse search page","description":"Data structure of resource reverse search page.","allOf":[{"$ref":"#/components/schemas/resource-reversesearchpage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchpage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/reversesearchpage/{resourceId}":{"get":{"summary":"Get a given reverse search page resource.","description":"Returns a single reverse search page resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of reverse search page to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (reversesearchpage).","readOnly":true,"example":"reversesearchpage"},"name":{"type":"string","description":"Localized name of resource (reverse search page).","readOnly":true,"example":"reverse search page"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/reversesearchpage/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested reverse search page resource","allOf":[{"$ref":"#/components/schemas/resource-reversesearchpage"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchpage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/assetrighttype":{"get":{"summary":"Find rights resources.","description":"Returns a list of rights resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetrighttype).","readOnly":true,"example":"assetrighttype"},"name":{"type":"string","description":"Localized name of resource (rights).","readOnly":true,"example":"rights"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetrighttype"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of rights","readOnly":true,"items":{"title":"rights","description":"Data structure of resource rights.","allOf":[{"$ref":"#/components/schemas/resource-assetrighttype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetrighttype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetrighttype/list":{"get":{"summary":"Get paginated list of rights resources.","description":"Returns a paginated list of rights resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetrighttype).","readOnly":true,"example":"assetrighttype"},"name":{"type":"string","description":"Localized name of resource (rights).","readOnly":true,"example":"rights"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetrighttype/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of rights","readOnly":true,"items":{"title":"rights","description":"Data structure of resource rights.","allOf":[{"$ref":"#/components/schemas/resource-assetrighttype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetrighttype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetrighttype/{resourceId}":{"get":{"summary":"Get a given rights resource.","description":"Returns a single rights resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of rights to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetrighttype).","readOnly":true,"example":"assetrighttype"},"name":{"type":"string","description":"Localized name of resource (rights).","readOnly":true,"example":"rights"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetrighttype/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested rights resource","allOf":[{"$ref":"#/components/schemas/resource-assetrighttype"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetrighttype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/role":{"get":{"summary":"Find role resources.","description":"Returns a list of role resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of role","readOnly":true,"items":{"title":"role","description":"Data structure of resource role.","allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new role","description":"Create one new role setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_infos","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_infosfr","in":"query","description":"Value to set to property infos (fr).","schema":{"type":"string"},"required":false},{"name":"prop_infosde","in":"query","description":"Value to set to property infosde.","schema":{"type":"string"},"required":false},{"name":"prop_rubrique","in":"query","description":"Identifiers of menu to set property menu available","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_resolutions","in":"query","description":"Identifiers of resolution to set property allowed download resolutions","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_pkgroletemplate","in":"query","description":"Identifier of role type to set to property role type","schema":{"type":"string"},"required":false},{"name":"prop_isdefaultexternal","in":"query","description":"Value to set to property default role for external users.","schema":{"type":"boolean"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_infos":{"description":"Value to set to property description.","type":"string"},"prop_infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"prop_infosde":{"description":"Value to set to property infosde.","type":"string"},"prop_rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"prop_isdefaultexternal":{"description":"Value to set to property default role for external users.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/role/list":{"get":{"summary":"Get paginated list of role resources.","description":"Returns a paginated list of role resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of role","readOnly":true,"items":{"title":"role","description":"Data structure of resource role.","allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/role/{resourceId}":{"get":{"summary":"Get a given role resource.","description":"Returns a single role resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested role resource","allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given role","description":"Modify the role setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infos","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infosfr","in":"query","description":"Value to set to property infos (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infosde","in":"query","description":"Value to set to property infosde.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_rubrique","in":"query","description":"Identifiers of menu to set property menu available","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_resolutions","in":"query","description":"Identifiers of resolution to set property allowed download resolutions","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_pkgroletemplate","in":"query","description":"Identifier of role type to set to property role type","schema":{"type":"string"},"required":false},{"name":"prop_isdefaultexternal","in":"query","description":"Value to set to property default role for external users.","schema":{"type":"boolean"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name","namefr","namede","infos","infosfr","infosde","rubrique","resolutions","pkgroletemplate","isdefaultexternal"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name","namefr","namede","infos","infosfr","infosde","rubrique","resolutions","pkgroletemplate","isdefaultexternal"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"prop_isdefaultexternal":{"description":"Value to set to property default role for external users.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given role","description":"Modify the role setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infos","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infosfr","in":"query","description":"Value to set to property infos (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_infosde","in":"query","description":"Value to set to property infosde.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_rubrique","in":"query","description":"Identifiers of menu to set property menu available","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_resolutions","in":"query","description":"Identifiers of resolution to set property allowed download resolutions","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_pkgroletemplate","in":"query","description":"Identifier of role type to set to property role type","schema":{"type":"string"},"required":false},{"name":"prop_isdefaultexternal","in":"query","description":"Value to set to property default role for external users.","schema":{"type":"boolean"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infos":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infosfr":{"description":"Value to set to property infos (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_infosde":{"description":"Value to set to property infosde.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"prop_isdefaultexternal":{"description":"Value to set to property default role for external users.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given role","description":"Delete definitively a role","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/role/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/role/{resourceId}/put":{"post":{"summary":"Modify a given role","description":"Modify the role setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/role/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_infos","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_infosfr","in":"query","description":"Value to set to property infos (fr).","schema":{"type":"string"},"required":false},{"name":"prop_infosde","in":"query","description":"Value to set to property infosde.","schema":{"type":"string"},"required":false},{"name":"prop_rubrique","in":"query","description":"Identifiers of menu to set property menu available","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_resolutions","in":"query","description":"Identifiers of resolution to set property allowed download resolutions","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_pkgroletemplate","in":"query","description":"Identifier of role type to set to property role type","schema":{"type":"string"},"required":false},{"name":"prop_isdefaultexternal","in":"query","description":"Value to set to property default role for external users.","schema":{"type":"boolean"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name","namefr","namede","infos","infosfr","infosde","rubrique","resolutions","pkgroletemplate","isdefaultexternal"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name","namefr","namede","infos","infosfr","infosde","rubrique","resolutions","pkgroletemplate","isdefaultexternal"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_infos":{"description":"Value to set to property description.","type":"string"},"prop_infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"prop_infosde":{"description":"Value to set to property infosde.","type":"string"},"prop_rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"prop_isdefaultexternal":{"description":"Value to set to property default role for external users.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/role/{resourceId}/patch":{"post":{"summary":"Modify partially a given role","description":"Modify the role setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/role/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of role 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_infos","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_infosfr","in":"query","description":"Value to set to property infos (fr).","schema":{"type":"string"},"required":false},{"name":"prop_infosde","in":"query","description":"Value to set to property infosde.","schema":{"type":"string"},"required":false},{"name":"prop_rubrique","in":"query","description":"Identifiers of menu to set property menu available","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_resolutions","in":"query","description":"Identifiers of resolution to set property allowed download resolutions","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_pkgroletemplate","in":"query","description":"Identifier of role type to set to property role type","schema":{"type":"string"},"required":false},{"name":"prop_isdefaultexternal","in":"query","description":"Value to set to property default role for external users.","schema":{"type":"boolean"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"infos":{"description":"Value to set to property description.","type":"string"},"infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"infosde":{"description":"Value to set to property infosde.","type":"string"},"rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"isdefaultexternal":{"description":"Value to set to property default role for external users.","type":"boolean"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_infos":{"description":"Value to set to property description.","type":"string"},"prop_infosfr":{"description":"Value to set to property infos (fr).","type":"string"},"prop_infosde":{"description":"Value to set to property infosde.","type":"string"},"prop_rubrique":{"description":"Identifiers of menu to set property menu available","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of Menu."},{"type":"integer","format":"int32","description":"ID of Menu."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_resolutions":{"description":"Identifiers of resolution to set property allowed download resolutions","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of resolution."},{"type":"integer","format":"int32","description":"ID of resolution."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_pkgroletemplate":{"description":"Identifier of role type to set to property role type","type":"string"},"prop_isdefaultexternal":{"description":"Value to set to property default role for external users.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/role/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/role/workflow":{"get":{"summary":"Get role workflow.","description":"Returns the whole workflow tree of role resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of role","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/role/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given role.","description":"Returns all possible workflow actions to apply to a given role.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the role of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified role.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given role.","description":"Change the workflow state of specified role.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the role whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (role).","readOnly":true,"example":"role"},"name":{"type":"string","description":"Localized name of resource (role).","readOnly":true,"example":"role"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/role/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/assetseason":{"get":{"summary":"Find season resources.","description":"Returns a list of season resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetseason).","readOnly":true,"example":"assetseason"},"name":{"type":"string","description":"Localized name of resource (season).","readOnly":true,"example":"season"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetseason"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of season","readOnly":true,"items":{"title":"season","description":"Data structure of resource season.","allOf":[{"$ref":"#/components/schemas/resource-assetseason"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetseason/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/assetseason/list":{"get":{"summary":"Get paginated list of season resources.","description":"Returns a paginated list of season resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetseason).","readOnly":true,"example":"assetseason"},"name":{"type":"string","description":"Localized name of resource (season).","readOnly":true,"example":"season"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetseason/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of season","readOnly":true,"items":{"title":"season","description":"Data structure of resource season.","allOf":[{"$ref":"#/components/schemas/resource-assetseason"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetseason/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/assetseason/{resourceId}":{"get":{"summary":"Get a given season resource.","description":"Returns a single season resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of season to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (assetseason).","readOnly":true,"example":"assetseason"},"name":{"type":"string","description":"Localized name of resource (season).","readOnly":true,"example":"season"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/assetseason/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested season resource","allOf":[{"$ref":"#/components/schemas/resource-assetseason"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetseason/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/user":{"get":{"summary":"Find user resources.","description":"Returns a list of user resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (user).","readOnly":true,"example":"user"},"name":{"type":"string","description":"Localized name of resource (user).","readOnly":true,"example":"user"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/user"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of user","readOnly":true,"items":{"title":"user","description":"Data structure of resource user.","allOf":[{"$ref":"#/components/schemas/resource-user"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/user/list":{"get":{"summary":"Get paginated list of user resources.","description":"Returns a paginated list of user resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (user).","readOnly":true,"example":"user"},"name":{"type":"string","description":"Localized name of resource (user).","readOnly":true,"example":"user"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/user/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of user","readOnly":true,"items":{"title":"user","description":"Data structure of resource user.","allOf":[{"$ref":"#/components/schemas/resource-user"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/user/tree":{"get":{"summary":"Get user resources as tree.","description":"Returns a tree view of user resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"keywords","in":"query","description":"Activate the fast tree mode.\n\nThis service is much faster than the depth option in the standard service but the recoverable data and possibilities are limited.\n\nThese parameters are ignored in this mode: clusterdepth, treetop, treepathprops, workflows, variations, presets, thumbnail, facets, queryVersions, withVersions, rootquery, sortbyrelevance, secured, variation, player.\n\nOnly id and name can be gotten.","schema":{"type":"boolean","default":false},"required":false},{"name":"find","in":"query","description":"Full text search string if keywords=false.\n\nIf keywords=true, full text features are disabled. The syntax of this parameter is `:`. Available prefixes are:\n\n- equals: searches for keywords that are equal to the specified value;\n- startsWith: searches for keywords that begin with the specified value;\n- contains: searches for keywords that contain the specified value;\n- matches: searches for keywords that match the specified (Java) pattern;\n- default is contains.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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. If keywords=true, the sorting is only done on the first indicated field","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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (user).","readOnly":true,"example":"user"},"name":{"type":"string","description":"Localized name of resource (user).","readOnly":true,"example":"user"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/user/tree"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of user","readOnly":true,"items":{"title":"user","description":"Data structure of resource user.","allOf":[{"$ref":"#/components/schemas/resource-user"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/user/{resourceId}":{"get":{"summary":"Get a given user resource.","description":"Returns a single user resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of user to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (user).","readOnly":true,"example":"user"},"name":{"type":"string","description":"Localized name of resource (user).","readOnly":true,"example":"user"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/user/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested user resource","allOf":[{"$ref":"#/components/schemas/resource-user"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/user/{resourceId}/{propertyId}":{"get":{"summary":"Get binary file of user resource of specified ID.","description":"Get original or transformed binary file.","tags":["retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of user resource from which to get the binary.","schema":{"type":"integer"},"required":true},{"name":"propertyId","in":"path","description":"Name of binary property.","schema":{"type":"string","enum":["avatar"]},"required":true},{"name":"index","in":"query","description":"Index of image for a multiple image binary resource file preview.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"filename","in":"query","description":"Wanted file name for attachment. Use *\\${original}* to get the stored file name.","schema":{"type":"string"},"required":false},{"name":"variation","in":"query","description":"Name of wanted variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","$preview","$previewtiny","$previewsmall","$previewbig","$previewreal","pdf","html","zip","wxml"]},"required":false},{"name":"preset","in":"query","description":"Name of preset to apply","schema":{"type":"string"},"required":false},{"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":"strip","in":"query","description":"If true, removes all metadata in transformed image (applied only if transform specified)","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"},"examples":{"sampleFile":{"summary":"An image example","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"},"sampleFileWithTransform":{"summary":"A image example with `transform=w_proportional,h_50p,c_lresize`","description":"![Example](https://club-wed.wedia-group.com:443/api/rest/examples/transformed_image_example)","externalValue":"https://club-wed.wedia-group.com:443/api/rest/examples/empty_example"}}}},"headers":{"X-WediaRest-Variation":{"description":"Type of variation","schema":{"type":"string","enum":["original","thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]}},"X-WediaRest-Resource-Count":{"description":"Number of existing sub-images for variation","schema":{"type":"integer"}},"X-WediaRest-Resource-Index":{"description":"Index of the sub-image","schema":{"type":"integer"}}}}}}},"/data/userregistration":{"get":{"summary":"Find user pending approval resources.","description":"Returns a list of user pending approval resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (userregistration).","readOnly":true,"example":"userregistration"},"name":{"type":"string","description":"Localized name of resource (user pending approval).","readOnly":true,"example":"user pending approval"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/userregistration"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of user pending approval","readOnly":true,"items":{"title":"user pending approval","description":"Data structure of resource user pending approval.","allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new user pending approval","description":"Create one new user pending approval setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_firstname","in":"query","description":"Value to set to property first name.","schema":{"type":"string"},"required":false},{"name":"prop_lastname","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_login","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":false},{"name":"prop_company","in":"query","description":"Value to set to property company.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"firstname":{"description":"Value to set to property first name.","type":"string"},"lastname":{"description":"Value to set to property name.","type":"string"},"login":{"description":"Value to set to property email.","type":"string"},"company":{"description":"Value to set to property company.","type":"string"}},"required":["firstname","lastname","login","company"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"firstname":{"description":"Value to set to property first name.","type":"string"},"lastname":{"description":"Value to set to property name.","type":"string"},"login":{"description":"Value to set to property email.","type":"string"},"company":{"description":"Value to set to property company.","type":"string"}},"required":["firstname","lastname","login","company"]},"prop_firstname":{"description":"Value to set to property first name.","type":"string"},"prop_lastname":{"description":"Value to set to property name.","type":"string"},"prop_login":{"description":"Value to set to property email.","type":"string"},"prop_company":{"description":"Value to set to property company.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (userregistration).","readOnly":true,"example":"userregistration"},"name":{"type":"string","description":"Localized name of resource (user pending approval).","readOnly":true,"example":"user pending approval"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/userregistration"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (userregistration).","readOnly":true,"example":"userregistration"},"name":{"type":"string","description":"Localized name of resource (user pending approval).","readOnly":true,"example":"user pending approval"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/userregistration"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/userregistration"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/userregistration/list":{"get":{"summary":"Get paginated list of user pending approval resources.","description":"Returns a paginated list of user pending approval resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (userregistration).","readOnly":true,"example":"userregistration"},"name":{"type":"string","description":"Localized name of resource (user pending approval).","readOnly":true,"example":"user pending approval"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/userregistration/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of user pending approval","readOnly":true,"items":{"title":"user pending approval","description":"Data structure of resource user pending approval.","allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/userregistration/{resourceId}":{"get":{"summary":"Get a given user pending approval resource.","description":"Returns a single user pending approval resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of user pending approval to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (userregistration).","readOnly":true,"example":"userregistration"},"name":{"type":"string","description":"Localized name of resource (user pending approval).","readOnly":true,"example":"user pending approval"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/userregistration/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested user pending approval resource","allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/usergroup":{"get":{"summary":"Find usergroup resources.","description":"Returns a list of usergroup resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/usergroup"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of usergroup","readOnly":true,"items":{"title":"usergroup","description":"Data structure of resource usergroup.","allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new usergroup","description":"Create one new usergroup setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (spanish).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_descriptiones","in":"query","description":"Value to set to property descriptiones.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (spanish).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_type":{"description":"Value to set to property type.","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/usergroup/list":{"get":{"summary":"Get paginated list of usergroup resources.","description":"Returns a paginated list of usergroup resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/usergroup/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of usergroup","readOnly":true,"items":{"title":"usergroup","description":"Data structure of resource usergroup.","allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/usergroup/{resourceId}":{"get":{"summary":"Get a given usergroup resource.","description":"Returns a single usergroup resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of usergroup to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/usergroup/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested usergroup resource","allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given usergroup","description":"Modify the usergroup setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of usergroup to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (spanish).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptiones","in":"query","description":"Value to set to property descriptiones.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given usergroup","description":"Modify the usergroup setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of usergroup to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (spanish).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_descriptiones","in":"query","description":"Value to set to property descriptiones.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","type"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name","type"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namees":{"description":"Value to set to property name (spanish).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_description":{"description":"Value to set to property description.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionfr":{"description":"Value to set to property description (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptionde":{"description":"Value to set to property description (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_descriptiones":{"description":"Value to set to property descriptiones.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_type":{"description":"Value to set to property type.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/usergroup/{resourceId}/put":{"post":{"summary":"Modify a given usergroup","description":"Modify the usergroup setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/usergroup/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of usergroup to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (spanish).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_descriptiones","in":"query","description":"Value to set to property descriptiones.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","namefr","namede","namees","description","descriptionfr","descriptionde","descriptiones","team","viewers","type"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (spanish).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_type":{"description":"Value to set to property type.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/usergroup/{resourceId}/patch":{"post":{"summary":"Modify partially a given usergroup","description":"Modify the usergroup setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/usergroup/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of usergroup 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"prop_namees","in":"query","description":"Value to set to property name (spanish).","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false},{"name":"prop_descriptionfr","in":"query","description":"Value to set to property description (fr).","schema":{"type":"string"},"required":false},{"name":"prop_descriptionde","in":"query","description":"Value to set to property description (de).","schema":{"type":"string"},"required":false},{"name":"prop_descriptiones","in":"query","description":"Value to set to property descriptiones.","schema":{"type":"string"},"required":false},{"name":"prop_team","in":"query","description":"Identifiers of user to set property team","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_viewers","in":"query","description":"Identifiers of user to set property viewers","schema":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"required":false},{"name":"prop_type","in":"query","description":"Value to set to property type.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","type"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"},"namees":{"description":"Value to set to property name (spanish).","type":"string"},"description":{"description":"Value to set to property description.","type":"string"},"descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"descriptionde":{"description":"Value to set to property description (de).","type":"string"},"descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"type":{"description":"Value to set to property type.","type":"string"}},"required":["name","type"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","type":"string"},"prop_namees":{"description":"Value to set to property name (spanish).","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"},"prop_descriptionfr":{"description":"Value to set to property description (fr).","type":"string"},"prop_descriptionde":{"description":"Value to set to property description (de).","type":"string"},"prop_descriptiones":{"description":"Value to set to property descriptiones.","type":"string"},"prop_team":{"description":"Identifiers of user to set property team","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_viewers":{"description":"Identifiers of user to set property viewers","oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","properties":{"$mode":{"type":"string","enum":["REPLACE","MAP","APPEND","REMOVE","RETAIN","APPENDNEW","REMOVEFIRST","REMOVELAST","CLEAR","MULTIPLE"],"description":"Id replacement mode among:\n\n* REPLACE (default): replace all current ids with specified ones;\n* APPEND: append specified ids to current ones;\n* REMOVE: remove specified ids from current ones;\n* RETAIN: Keep only the ids that are common between the currents and the specified ones.;\n* APPENDNEW: append specified ids to current ones, if there aren't already in current ids;\n* REMOVEFIRST: remove specified ids from current ones, from the beginning (left);\n* REMOVELAST: remove specified ids from current ones, from the end (right);\n* CLEAR: remove all current ids, ignoring specified ones;\n* MAP: replace ids by other (with a mapping, id to id);\n"},"$values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"ID of User."},{"type":"integer","format":"int32","description":"ID of User."}]},"uniqueItems":true},{"type":"object","description":"Replacement mappings: names are ids to replace, corresponding values are id to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for MAP_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for MAP_.","additionalProperties":{"type":"string","description":"Name is id to replace, corresponding value is id to replace with. _Only for MAP_."}}}]}}}]},"prop_type":{"description":"Value to set to property type.","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (usergroup).","readOnly":true,"example":"usergroup"},"name":{"type":"string","description":"Localized name of resource (usergroup).","readOnly":true,"example":"usergroup"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/usergroup/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/videoratio":{"get":{"summary":"Find videoratio resources.","description":"Returns a list of videoratio resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (videoratio).","readOnly":true,"example":"videoratio"},"name":{"type":"string","description":"Localized name of resource (videoratio).","readOnly":true,"example":"videoratio"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/videoratio"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of videoratio","readOnly":true,"items":{"title":"videoratio","description":"Data structure of resource videoratio.","allOf":[{"$ref":"#/components/schemas/resource-videoratio"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/videoratio/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/videoratio/list":{"get":{"summary":"Get paginated list of videoratio resources.","description":"Returns a paginated list of videoratio resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (videoratio).","readOnly":true,"example":"videoratio"},"name":{"type":"string","description":"Localized name of resource (videoratio).","readOnly":true,"example":"videoratio"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/videoratio/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of videoratio","readOnly":true,"items":{"title":"videoratio","description":"Data structure of resource videoratio.","allOf":[{"$ref":"#/components/schemas/resource-videoratio"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/videoratio/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/videoratio/{resourceId}":{"get":{"summary":"Get a given videoratio resource.","description":"Returns a single videoratio resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of videoratio to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (videoratio).","readOnly":true,"example":"videoratio"},"name":{"type":"string","description":"Localized name of resource (videoratio).","readOnly":true,"example":"videoratio"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/videoratio/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested videoratio resource","allOf":[{"$ref":"#/components/schemas/resource-videoratio"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/videoratio/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/vincent":{"get":{"summary":"Find vincent resources.","description":"Returns a list of vincent resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of vincent","readOnly":true,"items":{"title":"vincent","description":"Data structure of resource vincent.","allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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":"Create new vincent","description":"Create one new vincent setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"unzip","in":"query","description":"If true and we upload an archive file (zip, 7z, tar/tar.gz, tgz, bz, bz2, jar, arj, ar, cpio), we create one resource per file found in the archive.","schema":{"type":"boolean","default":"false"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock objects:\n* a boolean true to lock objects;\n* a boolean false to unlock objects;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":{"201":{"description":"When new resource is created","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"When creation has been cancelled","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"200":{"description":"When archive file has been uploaded in unzip mode. See returned results to know success and/or failure.","content":{"application/json":{"schema":{"type":"object","description":"List of files found in the archive and the corresponding created resources and rejects.","properties":{"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"},"archiveentrycount":{"type":"integer","format":"int32","description":"Number of entries in the archive","readOnly":true,"example":12},"importedfilecount":{"type":"integer","format":"int32","description":"Number of entries successfully imported","readOnly":true,"example":10},"processedentrycount":{"type":"integer","format":"int32","description":"Number of processed entries (some entries are ignore, by example hidden files, zero-byte files, etc)","readOnly":true,"example":10},"files":{"type":"array","description":"List of processed files","readOnly":true,"items":{"type":"object","description":"File entry description","properties":{"entryName":{"type":"string","description":"Name of entry","readOnly":true},"effectiveMode":{"type":"string","description":"Evaluated type of operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"finalMode":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","ERROR","CANCEL"],"readOnly":true},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource (or null if mode is ERROR or CANCEL).","nullable":true,"readOnly":true},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true,"nullable":true}}}}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"Result of all operations (List of created or modified resources, and rejects)","items":{"type":"object","description":"Result of operation on one entry","properties":{"entryName":{"type":"string","description":"Name of entry, only in case of error"},"importError":{"type":"object","description":"In case of error during reading entry, give the error","readOnly":true,"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"}}},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"entryName":{"type":"string","description":"Name of entry"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/912|Occurs when uploading an archive file in unzip mode and the file cannot be opened or read correctly (unsupported format or corrupted file).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/912)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/vincent/list":{"get":{"summary":"Get paginated list of vincent resources.","description":"Returns a paginated list of vincent resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of vincent","readOnly":true,"items":{"title":"vincent","description":"Data structure of resource vincent.","allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/vincent/{resourceId}":{"get":{"summary":"Get a given vincent resource.","description":"Returns a single vincent resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested vincent resource","allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}},"put":{"summary":"Modify a given vincent","description":"Modify the vincent setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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":"Modify partially a given vincent","description":"Modify the vincent setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}},"prop_name":{"description":"Value to set to property name.","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namefr":{"description":"Value to set to property name (fr).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]},"prop_namede":{"description":"Value to set to property name (de).","oneOf":[{"type":"string"},{"type":"object","properties":{"$stringhandling":{"type":"string","enum":["APPEND","PREPEND","APPENDLN","PREPENDLN","REPLACE","REPLACEEACH"],"description":"String replacement mode among:\n\n* APPEND: append new text at the end of the string;\n* PREPEND: prepend new text at the beginning of the string;\n* APPENDLN: append new text at the end of the string, after inserting a new line;\n* PREPENDLN: prepend new text at the beginning of the string, separated from old text with a new line;\n* REPLACE: replace text with new text;\n* REPLACEEACH: replace portions of text with new text, repeatedly;\n"},"$values":{"oneOf":[{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."},{"type":"array","description":"Texts to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_.","items":{"type":"string","description":"Text to append or prepend. _Only for APPEND, APPENDLN, PREPEND or PREPENDLN_."}},{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}},{"type":"array","description":"Replacement mappings list, to be applied successively. _Only for REPLACE or REPLACEEACH_.","items":{"type":"object","description":"Replacement mappings: names are string values to replace, corresponding values are text to replace with. _Only for REPLACE or REPLACEEACH_.","additionalProperties":{"type":"string","description":"Name is string value to replace, corresponding value is text to replace with. _Only for REPLACE or REPLACEEACH_."}}}]}}}]}}}},"*/*":{"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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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 a given vincent","description":"Delete definitively a vincent","tags":["deletions"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent to delete.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","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":"Success: specified resource has been deleted.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","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/api/rest/dam/data/vincent/{resourceId}"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"id":{"type":"string","description":"ID of the resource to be deleted","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4208|Occurs if the user does not have the right to delete this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4208)|\n|403/4210|Occurs when an attempt is made to delete a locked resource by another user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4210)|\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/4208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Deletion not allowed."},"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/4208"},"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"}}}}}}}}},"/data/vincent/{resourceId}/put":{"post":{"summary":"Modify a given vincent","description":"Modify the vincent setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PUT /data/vincent/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent to get.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}},"required":["name"]},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}/put"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/203|Occurs if the user does not have the right to create this type of resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/vincent/{resourceId}/patch":{"post":{"summary":"Modify partially a given vincent","description":"Modify the vincent setting the properties of the object by a json within the body or using multipart/form-data (properties can also be set in query). See details of passing properties below.\n\n > ⚠️ The property requirement is only indicated in the description of the parameter json object (body application/json or field `json` in multipart/form-data). If a property is marked there as required, it is sufficient that it has a value either in this json object, or in the corresponding field of the multipart/form-data, or in the corresponding parameter of the query. \n\n> ℹ️ This endpoint does the same thing as a PATCH /data/vincent/{resourceId}.","tags":["creations & modifications"],"parameters":[{"name":"resourceId","in":"path","description":"ID of vincent 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_namefr","in":"query","description":"Value to set to property name (fr).","schema":{"type":"string"},"required":false},{"name":"prop_namede","in":"query","description":"Value to set to property name (de).","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply after the creation","schema":{"type":"string"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"simu","in":"query","description":"If true, only simulate the action (do not modify the database). This is useful to evaluate faces ou check security for the provided data. If true, also set automatically parameter `withFaces` to true.","schema":{"type":"boolean","default":"false"}},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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}],"requestBody":{"description":"You can set properties within the body as json. You can also set properties within the multipart/form-data fields, or query parameters (the value of the parameter in the JSon has priority over the value of the parameter in the form which has priority over the value of the parameter in the query).\n___","content":{"application/json":{"schema":{"type":"object","description":"All properties to set to the resource as a json object. ","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"json":{"type":"object","description":"All properties to set to the resource as a json object.","properties":{"name":{"description":"Value to set to property name.","type":"string"},"namefr":{"description":"Value to set to property name (fr).","type":"string"},"namede":{"description":"Value to set to property name (de).","type":"string"}}},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_namefr":{"description":"Value to set to property name (fr).","type":"string"},"prop_namede":{"description":"Value to set to property name (de).","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":"Success: specified resource has been updated.","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"202":{"description":"Success, but specified resource hasn't been modified (nothing to modify, resource hasn't changed, or modifications cancelled)","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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/api/rest/dam/data/vincent/{resourceId}/patch"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true},"requestMode":{"type":"string","description":"Type of request","enum":["CREATE","UPDATE","CREATE_OR_UPDATE"],"readOnly":true,"default":"CREATE"},"effectiveMode":{"type":"string","description":"Type of action, deduced from the requestMode, the parameters and the state of the concerned resource","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"finalMode":{"type":"string","description":"Type of action, deduced from the effectiveMode, which may have been modified by extensions (business services) according to functional or technical rules","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"CREATE"},"selectionQuery":{"type":"string","description":"the query used to select the target resource in case of \"create or update\" action","readOnly":true,"nullable":true},"$actionname":{"type":"string","description":"Name of action","readOnly":true},"$servicetype":{"type":"string","description":"Service type","readOnly":true},"$damservice":{"type":"string","description":"Service name (end point)","readOnly":true},"$serviceid":{"type":"string","description":"Service ID","readOnly":true},"jsonParameter":{"type":"object","description":"The json parameters object if this parameter passing mode has been used, null otherwise.","readOnly":true,"nullable":true},"collectedParameters":{"type":"object","description":"The detected parameters to assign to target resource. In this object, keys are field names.","nullable":true,"additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"Name of parameter","nullable":true},"key":{"type":"boolean","description":"True if this parameter is used as key (create or update mode)","nullable":true},"source":{"type":"string","description":"Where the parameter has been got","enum":["body","query","json","part","config","defaults","metadata","internal"],"readOnly":true},"type":{"type":"string","description":"Value count","enum":["none","single","multiple"],"readOnly":true},"value":{"type":"string","description":"If value count is single, the value of parameter","nullable":true,"readOnly":true},"values":{"type":"array","description":"If value count is multiple, the values of parameter","items":{"type":"string"},"nullable":true,"readOnly":true}}}},"modifiedProperties":{"type":"array","description":"List of assigned or modified properties","items":{"type":"string"},"readOnly":true},"keys":{"type":"array","description":"List of keys","items":{"type":"string"},"readOnly":true,"nullable":true},"businessService":{"type":"object","description":"Business service used if any.","properties":{"plugin":{"type":"string","description":"Name of the plugin that defines the business service."},"classname":{"type":"string","description":"Name of the class that implements the business service."},"lock":{"type":"string","description":"Lock id.","nullable":true}},"readOnly":true,"nullable":true},"applyTrigger":{"type":"boolean","description":"true if triggers are applyed during operation"},"assetField":{"type":"boolean","description":"true if asset field is assigned ou modified during operation"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"$action":{"type":"object","description":"Describle this action","readOnly":true,"properties":{"type":{"type":"string","description":"Real type of final operation","enum":["CREATE","UPDATE","CANCEL","ERROR"],"readOnly":true,"default":"UPDATE"},"id":{"type":"integer","format":"int32","description":"ID of created or modified resource","nullable":true,"readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of created or modified resource","nullable":true,"readOnly":true},"cancelledId":{"type":"integer","format":"int32","description":"If action is cancelled, ID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"$cancelledUUID":{"type":"string","description":"If action is cancelled, UUID of resource (only present if action is cancelled)","nullable":true,"readOnly":true},"createdId":{"type":"integer","format":"int32","description":"If action is creation, ID of created resource (only present if action is creation)","nullable":true,"readOnly":true},"$createdUUID":{"type":"string","description":"If action is creation, UUID of created resource (only present if action is creation)","readOnly":true,"nullable":true},"updatedId":{"type":"integer","format":"int32","description":"If action is modification, ID of updated resource (only present if action is modification)","nullable":true,"readOnly":true},"$updatedUUID":{"type":"string","nullable":true,"description":"If action is modification, UUID of updated resource (only present if action is modification)","readOnly":true},"info":{"description":"Additional information on the operation (usually generated by business services).","oneOf":[{"type":"string"},{"type":"object"}]},"workflowError":{"type":"object","description":"In case of error during a workflow state change, describe the error","readOnly":true,"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"}}}}},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"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 value for a mandatory property is not provided.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/904|Occurs when the value of an assigned property is not compliant (syntax error) or accepted (incorrect value, bad type, not allowed value...).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/904)|\n|400/4208|Occurs when an uploaded file is too large.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/4208)|\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/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}},"403":{"description":"Occurs when action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/4207|Occurs when an attempt is made to assign an unmodifiable property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4207)|\n|403/4215|Occurs if the user does not have the right to modify this resource.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4215)|\n|403/4212|Occurs when an attempt is made to directly assign a workflow state by its ID and the resource is not configured to.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/4212)|\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/4207"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property cannot be modified. "},"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/4207"},"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 competing mutual exclusion lock is not obtained because of timeout.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\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/2"},"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/2"},"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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4200|Occurs when trying to upload a file in the body and the object has several file properties, and it is not possible to determine which of these properties should be affected.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4200)|\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":"300/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"It is not possible to determine the binary resource to be recovered without specifying which one because there are several possible ones."},"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#300/4200"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4200|Occurs when trying to upload a file to a property that is not of the binary type.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4200)|\n|422/4201|Occurs when an attempt is made to upload a file and the resource does not have a binary type property.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4201)|\n|422/4205|Occurs when an attempt is made to upload a file and the size of the file cannot be determined.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4205)|\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":"422/4200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"The specified property is not of the binary resource type and therefore cannot be treated as such. "},"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#422/4200"},"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"}}}}}}}}},"/data/vincent/workflow":{"get":{"summary":"Get vincent workflow.","description":"Returns the whole workflow tree of vincent resources.","tags":["workflows"],"parameters":[{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow tree","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent/workflow"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of states of the workflow of vincent","readOnly":true,"items":{"allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)"},"final":{"type":"boolean","description":"True if this state is a final state (no state after)"},"actions":{"type":"array","description":"List of actions to change this state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"true if this state is a start state (no state before)"},"final":{"type":"boolean","description":"true if this state is a final state (no state after)"}}}]},"sources":{"type":"array","description":"List of source states (from which one can go to this state).","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions that lead from this source state","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}},"readOnly":true}}}]}},"targets":{"type":"array","description":"List of target states (to which one can go when coming from this state).","readOnly":true,"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"True if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"True if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"True if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}},{"type":"object","properties":{"original":{"type":"boolean","description":"True if this state is a start state (no state before)","readOnly":true},"final":{"type":"boolean","description":"True if this state is a final state (no state after)","readOnly":true},"actions":{"type":"array","description":"List of actions to go to this target state","readOnly":true,"items":{"type":"object","readOnly":true,"properties":{"id":{"type":"string","description":"ID of action","readOnly":true},"$uuid":{"type":"string","description":"UUID of action","readOnly":true},"name":{"type":"string","description":"Name of action","readOnly":true},"label":{"type":"string","description":"Localized name of action","readOnly":true}}}}}}]}}}}}}}]}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/vincent/workflow/{resourceId}":{"get":{"summary":"Get possible next workflow states for a given vincent.","description":"Returns all possible workflow actions to apply to a given vincent.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the vincent of which we want the possible workflow actions","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"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":"Workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent/workflow/123"}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow change actions that can be applied to the specified vincent.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"ID of action"},"$uuid":{"type":"string","description":"UUID of action"},"name":{"type":"string","description":"Name of action"},"label":{"type":"string","description":"Localized name of action"},"source":{"type":"object","description":"Source state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]},"target":{"type":"object","description":"Target state","allOf":[{"$ref":"#/components/schemas/workflow-status"},{"type":"object","properties":{"archivedstatus":{"type":"boolean","description":"true if this state is the archived state","readOnly":true},"onlinestatus":{"type":"boolean","description":"true if this state is the online state","readOnly":true},"draftstatus":{"type":"boolean","description":"true if this state is the draft state","readOnly":true},"deletedstatus":{"type":"boolean","description":"true if this state is the deleted state","readOnly":true}}}]}}}}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}},"post":{"summary":"Change workflow state of a given vincent.","description":"Change the workflow state of specified vincent.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"id of the vincent whose state you want to change","schema":{"type":"integer"},"required":true},{"name":"workflow","in":"query","description":"the name or id of workflow action to apply","schema":{"type":"string"}},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"lock","in":"query","description":"Allows to lock or unlock object:\n* a boolean true to lock object;\n* a boolean false to unlock object;\n* a integer(int64) to set the number of seconds (or followed by ms for milliseconds) to lock the object (0 means the default lock time of 30 seconds).","schema":{"oneOf":[{"type":"boolean"},{"type":"integer","format":"int64"},{"type":"string","pattern":"^\\d+ms$"}],"pattern":"^true|false|\\d+|\\d+ms$"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"applyTriggers","in":"query","description":"Set false to disable triggers. Has no effect if binary file is set (triggers are always executed).","schema":{"type":"boolean","default":"true"}},{"name":"withData","in":"query","description":"True to get resource data.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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":"Result","content":{"application/json":{"schema":{"type":"object","description":"Describes the operation and the resource concerned","properties":{"resource":{"type":"string","description":"Name of resource (vincent).","readOnly":true,"example":"vincent"},"name":{"type":"string","description":"Localized name of resource (vincent).","readOnly":true,"example":"vincent"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/vincent/workflow/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"description":"if `withData` is true, the new resource data","nullable":true,"readOnly":true,"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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"}}}}}}}}},"/data/wkfasset":{"get":{"summary":"Find wkfasset resources.","description":"Returns a list of wkfasset resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"name":{"type":"string","description":"Localized name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfasset"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of wkfasset","readOnly":true,"items":{"title":"wkfasset","description":"Data structure of resource wkfasset.","allOf":[{"$ref":"#/components/schemas/resource-wkfasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfasset/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/wkfasset/list":{"get":{"summary":"Get paginated list of wkfasset resources.","description":"Returns a paginated list of wkfasset resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"name":{"type":"string","description":"Localized name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfasset/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of wkfasset","readOnly":true,"items":{"title":"wkfasset","description":"Data structure of resource wkfasset.","allOf":[{"$ref":"#/components/schemas/resource-wkfasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfasset/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/wkfasset/{resourceId}":{"get":{"summary":"Get a given wkfasset resource.","description":"Returns a single wkfasset resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of wkfasset to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"name":{"type":"string","description":"Localized name of resource (wkfasset).","readOnly":true,"example":"wkfasset"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfasset/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested wkfasset resource","allOf":[{"$ref":"#/components/schemas/resource-wkfasset"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfasset/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/wkfpkgportal":{"get":{"summary":"Find wkfpkgportal resources.","description":"Returns a list of wkfpkgportal resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"name":{"type":"string","description":"Localized name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgportal"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of wkfpkgportal","readOnly":true,"items":{"title":"wkfpkgportal","description":"Data structure of resource wkfpkgportal.","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgportal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgportal/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/wkfpkgportal/list":{"get":{"summary":"Get paginated list of wkfpkgportal resources.","description":"Returns a paginated list of wkfpkgportal resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"name":{"type":"string","description":"Localized name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgportal/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of wkfpkgportal","readOnly":true,"items":{"title":"wkfpkgportal","description":"Data structure of resource wkfpkgportal.","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgportal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgportal/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/wkfpkgportal/{resourceId}":{"get":{"summary":"Get a given wkfpkgportal resource.","description":"Returns a single wkfpkgportal resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of wkfpkgportal to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"name":{"type":"string","description":"Localized name of resource (wkfpkgportal).","readOnly":true,"example":"wkfpkgportal"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgportal/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested wkfpkgportal resource","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgportal"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgportal/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/wkfpkgskmetadata":{"get":{"summary":"Find workflow 1 resources.","description":"Returns a list of workflow 1 resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"withRights","in":"query","description":"Set default value for `withEditRights` and `withDeleteRights` parameters. If not present, default is false","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep, export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withEditRights","in":"query","description":"If set, export `$canEdit` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"withDeleteRights","in":"query","description":"If set, export `$canDelete` property. About default value, see parameter `withRights`.","schema":{"oneOf":[{"type":"boolean","description":"If true, export the property only for the main resource (property isn't exported for linked resources)","example":"true"},{"type":"string","description":"If value is deep , export the property for all resources (including linked resources)","enum":["deep"],"example":"deep"}]}},{"name":"security","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"rscSecurity","in":"query","description":"The security actions you want to know if the user has the right or not, at the resource type level.\n\nA security action is defined by a domain name and an action name (in the domain). You write the domain name, followed by a slash, followed by the action name. The domain name and the slash can be omitted if the domain is the standard domain for CRUD actions.","schema":{"type":"string","pattern":"^(\\w+\\/)?(\\w+)$"},"style":"form","explode":true},{"name":"withFaces","in":"query","description":"If true show faces (form input field behavior according to the data). Default is set automatically to true if `simu` is true.","schema":{"type":"boolean","default":"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 resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgskmetadata).","readOnly":true,"example":"wkfpkgskmetadata"},"name":{"type":"string","description":"Localized name of resource (workflow 1).","readOnly":true,"example":"workflow 1"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":true}},"headers":{"$ref":"#/components/schemas/common-headers"},"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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgskmetadata"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"context":{"type":"object","description":"the json resource configuration in response context (merge of the base configuration and request)."},"data":{"type":"array","description":"List of workflow 1","readOnly":true,"items":{"title":"workflow 1","description":"Data structure of resource workflow 1.","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgskmetadata"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgskmetadata/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|The service is badly configured (unknown object).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n|404/4202|Resource property is unknown.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/4202)|\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 in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Syntax error in 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"}}}}}},"300":{"description":"Occurs when the service cannot determine one of several possible choices (usually due to a configuration error).\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|300/4201|Occurs when tree data is requested and it is not possible to determine the property that defines the tree structure.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#300/4201)|\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":"300/4201"},"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#300/4201"},"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"}}}}}},"422":{"description":"Occurs when the service cannot be executed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|422/4204|Occurs in case of a configuration error prevent the service from running.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#422/4204)|\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":"422/4204"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Misconfigured resource. 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#422/4204"},"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"}}}}}}}}},"/data/wkfpkgskmetadata/list":{"get":{"summary":"Get paginated list of workflow 1 resources.","description":"Returns a paginated list of workflow 1 resources.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgskmetadata).","readOnly":true,"example":"wkfpkgskmetadata"},"name":{"type":"string","description":"Localized name of resource (workflow 1).","readOnly":true,"example":"workflow 1"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgskmetadata/list"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of workflow 1","readOnly":true,"items":{"title":"workflow 1","description":"Data structure of resource workflow 1.","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgskmetadata"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgskmetadata/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}},"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}}},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"1.0"},"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}}}}}}}}},"/data/wkfpkgskmetadata/{resourceId}":{"get":{"summary":"Get a given workflow 1 resource.","description":"Returns a single workflow 1 resource for a resource id.","tags":["access to all resources","retrieve resource"],"parameters":[{"name":"resourceId","in":"path","description":"ID of workflow 1 to get.","schema":{"type":"integer"},"required":true},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"imghashes","in":"query","description":"Exports image hashes (A and D algorithm) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"metadata","in":"query","description":"Exports image metadata (EXIF, IPTC...) of binary files.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersionData","in":"query","description":"True to export available versions of resource with data of each version","schema":{"type":"boolean","default":false},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available players","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":"The resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"Name of resource (wkfpkgskmetadata).","readOnly":true,"example":"wkfpkgskmetadata"},"name":{"type":"string","description":"Localized name of resource (workflow 1).","readOnly":true,"example":"workflow 1"},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of this resource.","readOnly":true,"example":null,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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","readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/data/wkfpkgskmetadata/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters) for each resource type","readOnly":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"description":"The requested workflow 1 resource","allOf":[{"$ref":"#/components/schemas/resource-wkfpkgskmetadata"},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgskmetadata/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}}},"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}}}}}}}}},"/data/{resourceTypes}":{"get":{"summary":"Multi resource type research","description":"Find resources of specified types.","tags":["multi-resource access","retrieve resource"],"parameters":[{"name":"resourceTypes","in":"path","description":"List of types of resources in which to search.","schema":{"type":"array","items":{"type":"string"}},"style":"simple","explode":false,"required":true},{"name":"find","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"fulltext","in":"query","description":"Use find instead","schema":{"type":"string"},"required":false,"deprecated":true},{"name":"after","in":"query","description":"Resource token from which to export next resources.","schema":{"type":"string"},"required":false},{"name":"before","in":"query","description":"Resource token from which to export previous resources. Ignored if the after parameter is filled in.","schema":{"type":"string"},"required":false},{"name":"suggest","in":"query","description":"True to return research suggestions. The 'words' value reduces the response to only one suggestion id table.","schema":{"oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["words"]}]},"required":false},{"name":"i18n","in":"query","description":"Modifies localization behavior (overrides configuration parameter).","schema":{"type":"boolean"},"required":false},{"name":"raw","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"depth","in":"query","description":"Depth of tree:\n* no value to not display in depth\n* 0 get tree roots only;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32"},"required":false},{"name":"clusterdepth","in":"query","description":"Depth of cluster:\n* 0 to not display in depth;\n* a positive number to display a corresponding number of child levels;\n* a negative number to display all levels below.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treetop","in":"query","description":"Size of treepath:\n* 0 to not display;\n* a positive number to display a corresponding number of parent levels;\n* a negative number to display all parent level above.","schema":{"type":"integer","format":"int32","default":0},"required":false},{"name":"treepath","in":"query","description":"Order of treepath","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"required":false},{"name":"treepathprops","in":"query","description":"Defines treepath custom properties (A comma-separated list of properties).","schema":{"type":"array","items":{"type":"string","example":"prop1,prop2"}},"style":"form","explode":false,"required":false},{"name":"withSynonyms","in":"query","description":"If true, synonyms are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"withRelated","in":"query","description":"If true, related resources are exported while exporting thesaurus tree","schema":{"type":"boolean","default":false},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"dataHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the data read. The default value of this parameter is that of the headers parameter.","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":"updateHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for modifications and creations. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"rscHeaders","in":"query","description":"Exports the resource description. The default value of this parameter is the value of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"workflows","in":"query","description":"Exports available workflow actions.","schema":{"type":"boolean","default":false},"required":false},{"name":"presets","in":"query","description":"Exports available preset names for binary properties.","schema":{"type":"boolean","default":false},"required":false},{"name":"thumbnail","in":"query","description":"Configure how to exports available preview url.","schema":{"type":"array","items":{"type":"string","enum":["small","big","tiny","real","false"],"example":["small","tiny"]},"example":["small","tiny"]},"style":"form","explode":false,"examples":{"oneId":{"summary":"Get only small preview url","value":["small"]},"multipleIds":{"summary":"Get small and tiny preview url","value":["small","tiny"]},"disable":{"summary":"Get no preview url","value":["false"]}},"required":false},{"name":"facets","in":"query","description":"Apply facets.","schema":{"type":"boolean","default":false},"required":false},{"name":"queryVersions","in":"query","description":"True to disable version filter.","schema":{"type":"boolean","default":false},"required":false},{"name":"withVersions","in":"query","description":"True to export available versions of resource","schema":{"type":"boolean","default":false},"required":false},{"name":"withData","in":"query","description":"True to get resource data.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":true},"required":false},{"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":"techprops","in":"query","description":"Filters exported technical properties (A Comma-Separated list of properties (optionally prefixed with - to exclude), or none, or all).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"withAggregates","in":"query","description":"True to get aggregates.\n>💡 To get data count, use `withData=false&withAggregates=false`.","schema":{"type":"boolean","default":false},"required":false},{"name":"aggfields","in":"query","description":"Filters exported aggregates (a comma-separated list of field names, optionally followed by a list of associated property names in parentheses, or just a list of property names in parentheses to be applied to all fields.).","schema":{"type":"string"},"required":false,"examples":{"onlyFields":{"summary":"to restrict the aggregate fields","value":"location,keywords"},"fieldsAndProperties":{"summary":"Select fields and properties","value":"Location(id),keywords(name),colorspace(id,name)"},"propertiesForAllFields":{"summary":"Properties for all fields","value":"(id)"}}},{"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":"rootquery","in":"query","description":"When retrieving a tree, filters the exported resources at the root.\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, sort first by relevance then use orderby. If false, sort only by orderby. If omitted, use default behavior. Only relevant with fulltext search (see find)","schema":{"type":"boolean","example":false},"required":false},{"name":"findinfilecontent","in":"query","description":"modifies the default search behavior for fulltext search within attached files","schema":{"type":"boolean"},"required":false},{"name":"group","in":"query","description":"Definition of grouping.\n\nHierarchical grouping:\nString-based syntax defining hierarchical grouping levels.\n- semicolon-separated list of levels\n- each level is defined by:\n - comma-separated list of property definitions\n - optional max count using ':' suffix\n\nExample:\n coverage,created asc:10;status desc\n\nOther grouping modes:\nAggregated and collapsed grouping are configured using a JSON-based syntax.\nOnly the JSON form is officially supported for these modes.\n\nFor advanced grouping capabilities, see internal documentation:\nhttps://crossmedia.atlassian.net/wiki/spaces/WD/pages/2208366593/Accessing+data#Grouping","schema":{"type":"string"},"required":false},{"name":"grouplevel","in":"query","description":"in combination with group (only hierarchical mode), defines the specific level to be retrieved as a response to an ungrouped request","schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false},{"name":"groupcount","in":"query","description":"in combination with group (only collapsed mode), defines the counting mode.\nPossible values:\n* `disabled`: No counting is performed\n* `filtered` (default): Count after applying query filters.\n* `unfiltered`: Count regardless of query filters.","schema":{"type":"string","enum":["disabled","filtered","unfiltered"]},"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":"dateIso8601","in":"query","description":"Specifies if dates are ISO 8601 (RFC3339) or timestamp (Unix epoch).","schema":{"type":"boolean","default":false},"required":false},{"name":"variation","in":"query","description":"A list of variations or presets in a preferred order (Used to determine the variation obtained if this list is submitted to a variation service) (A comma-separated list of variation/preset ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"player","in":"query","description":"A list of players in a preferred order (Used to determine the player obtained if this list is submitted to a player service) (A comma-separated list of player ids).","schema":{"type":"array","items":{"type":"string","example":"poster,thumbnailSmall,original"}},"style":"form","explode":false,"required":false},{"name":"variations","in":"query","description":"Exports available variation metadata for binary asset (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n* `size` - Exports description, image size and file length\n* `content` - Exports description, image size, file length, content type and file suffix\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","content","size","uri","desc"],"default":"false"},"required":false},{"name":"players","in":"query","description":"Exports available player names, or metadata (Not available within trees).\n\nVerbosity:\n* `false` - Disable\n* `true` - Exports only names\n* `all` - Exports all data\n* `desc` - Exports description (name and caption)\n* `uri` - Exports description and URI\n\nOnly the value `true` (or `false`) can be used if the parameter `variation` is specified.","schema":{"type":"string","enum":["true","false","all","uri","desc"],"default":"false"},"required":false},{"name":"variationFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","schema":{"type":"boolean","default":true},"required":false},{"name":"playerFilter","in":"query","description":"If true, and parameters `variation` and `variations` are also specified, only the variation metadata corresponding to the variation selected by the parameter `variation` are exported.","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":"A list of resources","content":{"application/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resource types","readOnly":true,"items":{"type":"object","properties":{"resource":{"type":"string","description":"Type of resource.","readOnly":true},"name":{"type":"string","description":"Localized name of resource.","readOnly":true},"tree":{"type":"boolean","description":"The data are presented in a tree.","readOnly":true,"example":false},"treefield":{"type":"string","description":"If `tree`is true, the field on which the tree is defined"},"$version":{"type":"object","description":"Status data headers (present only if `withVersions` or `withVersionData` is true, null if resource is not workcopy compliant)","properties":{"archivedstatus":{"description":"Status 'archived' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true},"onlinestatus":{"type":"object","description":"Status 'online' description (or null if it doesn't exist)","allOf":[{"$ref":"#/components/schemas/workflow-status"}],"nullable":true,"readOnly":true}},"nullable":true,"readOnly":true},"read":{"type":"boolean","description":"true if this resource can be got by id (present only if resource headers are asked)","readOnly":true},"list":{"type":"boolean","description":"true if this resource can be got by list (present only if resource headers are asked)","readOnly":true},"update":{"type":"boolean","description":"true if modification of this resource is available (present only if resource headers are asked)","readOnly":true},"create":{"type":"boolean","description":"true if creation of this resource is available (present only if resource headers are asked)","readOnly":true},"createOrUpdate":{"type":"boolean","description":"true if create or update feature is available for this feature (present only if resource headers are asked)","readOnly":true},"delete":{"type":"boolean","description":"true if deletion of this resource is available (present only if resource headers are asked)","readOnly":true},"workflow":{"type":"boolean","description":"true if changing the workflow status of this resource is available (present only if resource headers are asked)","readOnly":true},"workcopy":{"type":"boolean","description":"true if workcopy feature is available for this resource (present only if resource headers are asked)","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true,"nullable":true},"$security":{"type":"object","description":"Granted actions for each asked `rscSecurity` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/insert":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/data/%7BresourceTypes%7D"},"resourcesContext":{"type":"object","description":"List of request contexts (part of configuration built from request parameters) for each resource type","readOnly":true,"additionalProperties":true},"commonContext":{"type":"object","description":"Common request context (part of configuration built from request parameters) for all resource types","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of ressources","readOnly":true,"items":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/resource-aicelebrity"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"aicelebrity"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicelebrity/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"aicelebrity"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicelebrity/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-aicolor"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"aicolor"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicolor/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"aicolor"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/aicolor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-ailandmark"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"ailandmark"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/ailandmark/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"ailandmark"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/ailandmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"asset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"asset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetauthor"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetauthor"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetauthor"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetauthor/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetchannel"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetchannel"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetchannel"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetchannel/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetcolorspace"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetcolorspace"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcolorspace/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetcolorspace"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcolorspace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetcoverage"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetcoverage"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetcoverage"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetcoverage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetformat"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetformat"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetformat/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetformat"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetformat/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetgeography"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetgeography"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetgeography"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgeography/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetgrouping"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetgrouping"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgrouping/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetgrouping"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetgrouping/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetiaconcept"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetiaconcept"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetiaconcept/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetiaconcept"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetiaconcept/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetkeyword"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetkeyword"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetkeyword"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetkeyword/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetlanguage"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetlanguage"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetlanguage"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetlanguage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetnature"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetnature"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetnature"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetnature/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetrighttype"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetrighttype"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetrighttype/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetrighttype"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetrighttype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetseason"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetseason"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetseason/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetseason"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetseason/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-assetvisibility"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"assetvisibility"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetvisibility/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"assetvisibility"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/assetvisibility/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandassettype"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandassettype"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandassettype"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandcenter"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandcenter"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandcenter"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandcriterion"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandcriterion"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandcriterion"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcriterion/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandguideline"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandguideline"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandguideline"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-brandreference"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"brandreference"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"brandreference"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-collaborativespace"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"collaborativespace"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"collaborativespace"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-contract"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"contract"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"contract"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-country"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"country"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/country/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"country"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/country/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-cspsource"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"cspsource"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/cspsource/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"cspsource"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/cspsource/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-folder"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"folder"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"folder"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/folder/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-gartnerdemo"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"gartnerdemo"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"gartnerdemo"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/gartnerdemo/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-genaitempimage"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"genaitempimage"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"genaitempimage"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-lang"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"lang"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"lang"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-legacy"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"legacy"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"legacy"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-organization"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"organization"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"organization"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/organization/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-pimasset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"pimasset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"pimasset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}},{"type":"object","properties":{"$versions":{"type":"array","description":"List of versions of resource.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of resource","readOnly":true},"version":{"type":"integer","format":"int32","description":"Number of version.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123"}}}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-pimassettype"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"pimassettype"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimassettype/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"pimassettype"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimassettype/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-pkgassetzipdownload"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"pkgassetzipdownload"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"pkgassetzipdownload"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pkgassetzipdownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-portal"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"portal"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"portal"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-portalbookmark"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"portalbookmark"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"portalbookmark"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-portaldownload"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"portaldownload"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"portaldownload"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaldownload/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-portaltheme"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"portaltheme"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"portaltheme"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-product"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"product"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"product"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/product/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-productcategory"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"productcategory"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"productcategory"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/productcategory/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-rekouser"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"rekouser"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"rekouser"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-resolution"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"resolution"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/resolution/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"resolution"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/resolution/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-reversesearch"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"reversesearch"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"reversesearch"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-reversesearchdomain"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"reversesearchdomain"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"reversesearchdomain"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-reversesearchmatch"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"reversesearchmatch"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"reversesearchmatch"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-reversesearchpage"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"reversesearchpage"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchpage/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"reversesearchpage"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchpage/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-role"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"role"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"role"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/role/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-user"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"user"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"user"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123"}}},{"type":"object","properties":{"$children":{"type":"array","description":"Children of this resource in the tree.","readOnly":true,"items":{"type":"object","additionalProperties":true}}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-usergroup"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"usergroup"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"usergroup"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/usergroup/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-userregistration"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"userregistration"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"userregistration"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/userregistration/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-videoratio"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"videoratio"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/videoratio/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"videoratio"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/videoratio/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-vincent"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"vincent"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"vincent"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/vincent/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-wkfasset"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"wkfasset"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfasset/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"wkfasset"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfasset/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-wkfpkgportal"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"wkfpkgportal"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgportal/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"wkfpkgportal"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgportal/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]},{"allOf":[{"$ref":"#/components/schemas/resource-wkfpkgskmetadata"},{"type":"object","properties":{"$resource":{"type":"string","description":"Type of resources","readOnly":true,"example":"wkfpkgskmetadata"}}},{"type":"object","properties":{"$lockedBy":{"oneOf":[{"type":"string","description":" * `surfer`: if surfer is owner of the lock\n * `unknown`: if owner couldn't be determinated","enum":["surfer","unknown"],"readOnly":true},{"type":"string","description":"If resource is locked, specifies the uuid of the owner of the lock","readOnly":true}],"description":"If null, the object is not locked.","nullable":true},"$i18n":{"type":"boolean","description":"Specify if data are localized","readOnly":true},"$href":{"type":"string","format":"uri","description":"Direct URI of the corresponding resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgskmetadata/123"}}},{"type":"object","properties":{"$nextResultsToken":{"type":"string","description":"Token to get the following resources.","readOnly":true,"example":"e02bfd79f34243f07159cc5bd0db1552"},"$groupSize":{"type":"integer","minimum":0,"description":"Number of objects belonging to the group represented by this item. Only present when collapsed grouping is enabled and counting is not disabled."}}},{"type":"object","properties":{"$suggestion":{"type":"string","description":"Proposed research text for the suggestion requested to find this resource","readOnly":true},"$suggestionField":{"type":"boolean","description":"Name of the field whose value matches the request for this resource","readOnly":true},"$suggestionValue":{"type":"string","description":"Value that matches the request for this resource.","readOnly":true},"$suggestionObject":{"type":"object","description":"Child resource that matches the request for this resource.","readOnly":true,"properties":{"id":{"type":"string","description":"ID the child resource","readOnly":true},"$resource":{"type":"string","description":"Type of the child resource","readOnly":true,"example":"wkfpkgskmetadata"},"$href":{"type":"string","format":"uri","description":"URI of corresponding child resource","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/keywords/123"}}},"$score":{"type":"number","format":"float","description":"Score.","readOnly":true},"$href":{"type":"string","format":"uri","description":"URI of the request to find resource if suggest parameter is true, other else direct URI of the corresponding resource.","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/wkfpkgskmetadata/123"}}},{"type":"object","properties":{"$security":{"type":"object","description":"Granted actions for each asked `security` actions","readOnly":true,"additionalProperties":{"type":"boolean","description":"Name is action (domain/action) and value is true if corresponding action is allowed."},"example":{"objectdata/update":true}},"$canEdit":{"type":"boolean","description":"true if resource is modifiable. Present if `withRights` or `withEditRights` parameter is true, or deep."},"$canDelete":{"type":"boolean","description":"true if resourc is deletable. Present if `withRights` or `withDeleteRights` parameter is true, or deep."}}}]}]}},"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}}}}}}}}}},"components":{"schemas":{"common-headers":{"type":"object","description":"headers descriptions (only if asked). Property keys are field names.","properties":{"name":{"type":"string","description":"Localized name of the field","readOnly":true},"taborder":{"type":"integer","format":"int32","description":"Tab order","readOnly":true},"i18n":{"type":"boolean","description":"True if field is internationalized (If true, this is the field for the default language).","readOnly":true},"i18nFor":{"type":"string","description":"The name of the corresponding internationalized field, if it is a localized field (for a specific language).","readOnly":true},"i18nLocale":{"type":"string","description":"The language (BCP47 with underscore as separator, language as ISO 639 alpha-2 and country as ISO 3166 alpha-2) of the field, if internationalized.","example":"en_US","readOnly":true},"exported":{"type":"boolean","description":"True if this field will be exported in data representing the resource.","readOnly":true},"indexed":{"type":"boolean","description":"True if this field is indexed, meaning it is searchable by fulltext","readOnly":true},"type":{"type":"string","enum":["string","number","boolean","resource","object","array","isodatetime","isodate","timestamp","tree","null","separator"],"description":"The data type of the field\n\n* `string`: string\n* `number`: number\n* `resource`: file or image\n* `object`: multi property data\n* `array`: list of objects\n* `isodatetime`: datetime as ISO 8601\n* `isodate`: date as ISO 8601\n* `timestamp`: Unix epoch\n* `tree`: tree object\n* `separator`: form section separator (no data)\n* `null`: JSon null value\n","readOnly":true},"text":{"type":"boolean","description":"If type is string, text to true means value is text (ie long plain text, html, json, etc)","readOnly":true},"maxlength":{"type":"integer","description":"The maximum length (maximum number of characters) of text that can be stored or -1 if no known limit.","readOnly":true},"nullIfEmpty":{"type":"boolean","description":"True means an empty string will be stored as null","readOnly":true},"texttype":{"type":"string","enum":["plain","html","json"],"description":"If text is true, type of the text","readOnly":true},"replaceCR":{"type":"boolean","description":"If text is true, replaceCR is true means CR must be replaced by BR in lists.","readOnly":true},"html":{"type":"boolean","description":"If text is true, true if texttype is html.","readOnly":true},"tree":{"type":"boolean","description":"True if define a tree, ie the field value is the ID of the parent NODE, or the nature of the field is a tree","readOnly":true},"cluster":{"type":"boolean","description":"True if define a cluster (field data type is a collection of objects that point to objects of the same type)","readOnly":true},"href":{"type":"string","format":"uri","description":"If field is of type relational (ie type is object or array), href is the URI of an end point to get values of the nature of the field","readOnly":true,"example":"/api/rest/dam/data/category"},"properties":{"$ref":"#/components/schemas/nature-headers"},"group":{"type":"object","description":"Describe the group of fields (form subsection or tab)","properties":{"id":{"type":"string","description":"ID of the group"},"name":{"type":"string","description":"Localized title of the group"}},"nullable":true,"readOnly":true},"cud":{"type":"object","description":"Headers for creation, modification and deletion. Only relevant properties are present.","readOnly":true,"properties":{"key":{"type":"boolean","description":"true if this field is a key","readOnly":true},"update":{"type":"boolean","description":"true if this field is modifiable","readOnly":true},"create":{"type":"boolean","description":"true if this field is relational and instance of nature of the field could be created","readOnly":true},"childrenAllowedUpdateModes":{"type":"array","description":"If the field is of type multiple relational type, list the allowed modes of change","items":{"type":"string","enum":["replace","map","append","remove","retain","appendnew","removefirst","removelast","clear"]},"readOnly":true},"mandatoryStructure":{"type":"boolean","description":"true if field is mandatory in the DB structure","readOnly":true},"mandatoryCreate":{"type":"boolean","description":"true if this field is mandatory when creating the resource with this end point","readOnly":true},"mandatoryUpdate":{"type":"boolean","description":"true if this field is mandatory when modifiying (PUT) the resource with this end point","readOnly":true},"mandatoryPatch":{"type":"boolean","description":"true if this field is mandatory when modifiying partially (PATCH) the resource with this end point","readOnly":true},"defaultStructure":{"type":"string","description":"The default value for the field as defined in DB structure","readOnly":true},"defaultCreate":{"type":"string","description":"The default value for the field when creating the resource with this end point","readOnly":true},"defaultUpdate":{"type":"string","description":"The default value for the field when modifiying (PUT) the resource with this end point","readOnly":true},"defaultPatch":{"type":"boolean","description":"The default value for the field when modifiying partially (PATCH) the resource with this end point","readOnly":true},"delete":{"type":"boolean","description":"true if a collection item pointed by this field can be deleted with this end point","readOnly":true},"uploadMaxKibi":{"type":"integer","format":"int32","description":"Maximum size of file to upload if type is resource","readOnly":true,"nullable":true}}}}},"nature-headers":{"type":"object","description":"If field is of type relational (ie type is object or array), field nature headers descriptions. Property keys are field names.","properties":{"name":{"type":"string","description":"Localized name of the field","readOnly":true},"taborder":{"type":"integer","format":"int32","description":"Tab order","readOnly":true},"i18n":{"type":"boolean","description":"True if field is internationalized (If true, this is the field for the default language).","readOnly":true},"i18nFor":{"type":"string","description":"The name of the corresponding internationalized field, if it is a localized field (for a specific language).","readOnly":true},"i18nLocale":{"type":"string","description":"The language (BCP47 with underscore as separator, language as ISO 639 alpha-2 and country as ISO 3166 alpha-2) of the field, if internationalized.","example":"en_US","readOnly":true},"exported":{"type":"boolean","description":"True if this field will be exported in data representing the resource.","readOnly":true},"indexed":{"type":"boolean","description":"True if this field is indexed, meaning it is searchable by fulltext","readOnly":true},"type":{"type":"string","enum":["string","number","boolean","resource","object","array","isodatetime","isodate","timestamp","tree","null","separator"],"description":"The data type of the field\n\n* `string`: string\n* `number`: number\n* `resource`: file or image\n* `object`: multi property data\n* `array`: list of objects\n* `isodatetime`: datetime as ISO 8601\n* `isodate`: date as ISO 8601\n* `timestamp`: Unix epoch\n* `tree`: tree object\n* `separator`: form section separator (no data)\n* `null`: JSon null value\n","readOnly":true},"text":{"type":"boolean","description":"If type is string, text to true means value is text (ie long plain text, html, json, etc)","readOnly":true},"maxlength":{"type":"integer","description":"The maximum length (maximum number of characters) of text that can be stored or -1 if no known limit.","readOnly":true},"nullIfEmpty":{"type":"boolean","description":"True means an empty string will be stored as null","readOnly":true},"texttype":{"type":"string","enum":["plain","html","json"],"description":"If text is true, type of the text","readOnly":true},"replaceCR":{"type":"boolean","description":"If text is true, replaceCR is true means CR must be replaced by BR in lists.","readOnly":true},"html":{"type":"boolean","description":"If text is true, true if texttype is html.","readOnly":true},"tree":{"type":"boolean","description":"True if define a tree, ie the field value is the ID of the parent NODE, or the nature of the field is a tree","readOnly":true},"cluster":{"type":"boolean","description":"True if define a cluster (field data type is a collection of objects that point to objects of the same type)","readOnly":true},"href":{"type":"string","format":"uri","description":"If field is of type relational (ie type is object or array), href is the URI of an end point to get values of the nature of the field","readOnly":true,"example":"/api/rest/dam/data/category"},"properties":{"$ref":"#/components/schemas/nature-headers"},"group":{"type":"object","description":"Describe the group of fields (form subsection or tab)","properties":{"id":{"type":"string","description":"ID of the group"},"name":{"type":"string","description":"Localized title of the group"}},"nullable":true,"readOnly":true},"cud":{"type":"object","description":"Headers for creation, modification and deletion. Only relevant properties are present.","readOnly":true,"properties":{"key":{"type":"boolean","description":"true if this field is a key","readOnly":true},"update":{"type":"boolean","description":"true if this field is modifiable","readOnly":true},"create":{"type":"boolean","description":"true if this field is relational and instance of nature of the field could be created","readOnly":true},"childrenAllowedUpdateModes":{"type":"array","description":"If the field is of type multiple relational type, list the allowed modes of change","items":{"type":"string","enum":["replace","map","append","remove","retain","appendnew","removefirst","removelast","clear"]},"readOnly":true},"mandatoryStructure":{"type":"boolean","description":"true if field is mandatory in the DB structure","readOnly":true},"mandatoryCreate":{"type":"boolean","description":"true if this field is mandatory when creating the resource with this end point","readOnly":true},"mandatoryUpdate":{"type":"boolean","description":"true if this field is mandatory when modifiying (PUT) the resource with this end point","readOnly":true},"mandatoryPatch":{"type":"boolean","description":"true if this field is mandatory when modifiying partially (PATCH) the resource with this end point","readOnly":true},"defaultStructure":{"type":"string","description":"The default value for the field as defined in DB structure","readOnly":true},"defaultCreate":{"type":"string","description":"The default value for the field when creating the resource with this end point","readOnly":true},"defaultUpdate":{"type":"string","description":"The default value for the field when modifiying (PUT) the resource with this end point","readOnly":true},"defaultPatch":{"type":"boolean","description":"The default value for the field when modifiying partially (PATCH) the resource with this end point","readOnly":true},"delete":{"type":"boolean","description":"true if a collection item pointed by this field can be deleted with this end point","readOnly":true},"uploadMaxKibi":{"type":"integer","format":"int32","description":"Maximum size of file to upload if type is resource","readOnly":true,"nullable":true}}}}},"workflow-status":{"type":"object","description":"Workflow status description","properties":{"id":{"type":"string","description":"ID of state"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"UUID of state"},"name":{"type":"string","description":"Name of state"},"label":{"type":"string","description":"Localized name of state"},"color":{"type":"string","description":"Color for state (as a HTML color)","example":"#04E6F7"}},"readOnly":true},"resource-aicelebrity":{"type":"object","title":"celebrity","description":"Data structure of resource celebrity. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-aicolor":{"type":"object","title":"AI colors","description":"Data structure of resource AI colors. \n\n\n\n> *AI* / Main color","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"code":{"type":"string","description":"Value of code","readOnly":true},"namefr":{"type":"string","description":"Value of name (FR)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-ailandmark":{"type":"object","title":"landmark","description":"Data structure of resource landmark. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-asset":{"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","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of modified at","readOnly":true},"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user.","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123/binary"}}},"dteendrights":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of expiration date"},"source":{"type":"object","description":"Data for source file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123/source"}}},"keywords":{"type":"array","description":"Data for keyword.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of keyword","readOnly":true}}}},"$moreChildren_keywords":{"type":"object","description":"Because the list of asset attached to the keyword property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"photograph":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of last name","readOnly":true}},"description":"Data for photographer."},"namede":{"type":"string","description":"Value of name (DE)"},"description":{"type":"string","description":"Value of caption"},"descriptionfr":{"type":"string","description":"Value of caption (FR)"},"descriptionde":{"type":"string","description":"Value of caption (DE)"},"assetformat":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for orientation.","readOnly":true},"width":{"type":"integer","format":"int32","description":"Value of width","readOnly":true},"height":{"type":"integer","format":"int32","description":"Value of height","readOnly":true},"duration":{"type":"number","format":"double","description":"Value of duration","readOnly":true},"clipped":{"type":"boolean","description":"Value of clipped","readOnly":true},"filesize":{"type":"number","format":"double","description":"Value of file size","readOnly":true},"colorspace":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for color space.","readOnly":true},"nbpages":{"type":"integer","format":"int32","description":"Value of page count","readOnly":true},"copietravail":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset.\n\n\n\n> Application base DAM object\n","readOnly":true},"uid":{"type":"string","description":"Value of uid","readOnly":true},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true},"originalfilename":{"type":"string","description":"Value of original file name","readOnly":true},"resolution":{"type":"string","description":"Value of resolution","readOnly":true},"assetnature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset type.","readOnly":true},"poster":{"type":"object","description":"Data for poster property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123/poster"}}},"ai_caption":{"type":"string","description":"Value of AI-generated caption (EN)","readOnly":true},"righttype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for rights."},"ai_nbfaces":{"type":"integer","format":"int32","description":"Value of AI people count","readOnly":true},"ai_mainbg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"ai_mainfg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"authorizedchannel":{"type":"array","description":"Data for channel.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_authorizedchannel":{"type":"object","description":"Because the list of asset attached to the channel property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"ai_faces":{"type":"string","description":"Value of AI faces attributes","readOnly":true},"shootingdate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of shooting date"},"coverage":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for collection."},"folder":{"type":"array","description":"Data for folder.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_folder":{"type":"object","description":"Because the list of asset attached to the folder property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for organization."},"ai_concepts":{"type":"array","description":"Data for AI concepts.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of AI keyword","readOnly":true}}}},"$moreChildren_ai_concepts":{"type":"object","description":"Because the list of asset attached to the AI concepts property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"ai_nbfaces_baby":{"type":"integer","format":"int32","description":"Value of baby count","readOnly":true},"ai_nbfaces_children":{"type":"integer","format":"int32","description":"Value of children count","readOnly":true},"ai_nbfaces_adult":{"type":"integer","format":"int32","description":"Value of adult count","readOnly":true},"ai_nbfaces_senior":{"type":"integer","format":"int32","description":"Value of senior people count","readOnly":true},"nbentries":{"type":"integer","format":"int32","description":"Value of file count in zip archive","readOnly":true},"blurhash":{"type":"string","description":"Value of blurhash","readOnly":true},"ai_captionfr":{"type":"string","description":"Value of AI caption (FR)","readOnly":true},"ai_captionde":{"type":"string","description":"Value of AI caption (DE)","readOnly":true},"videoratio":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for video ratio.","readOnly":true},"tmpsource":{"type":"string","description":"Value of tmpsource","readOnly":true},"langs":{"type":"array","description":"Data for languages.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_langs":{"type":"object","description":"Because the list of asset attached to the languages property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"location":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for geographical thesaurus."},"displayweight":{"type":"integer","format":"int32","description":"Value of featured assets"},"ai_celebrities":{"type":"array","description":"Data for celebrity.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_celebrities":{"type":"object","description":"Because the list of asset attached to the celebrity property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"ai_landmarks":{"type":"array","description":"Data for landmark.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_landmarks":{"type":"object","description":"Because the list of asset attached to the landmark property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"season":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for season."},"imgbnksrc":{"type":"string","description":"Value of image bank source","readOnly":true},"spaces":{"type":"array","description":"Data for space.\n\n\n\n> This object represents a collaborative space.\n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_spaces":{"type":"object","description":"Because the list of asset attached to the space property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"portals":{"type":"array","description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_portals":{"type":"object","description":"Because the list of asset attached to the portals property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"brandassettype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for brand asset type."},"grouping":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for grouping."},"groupingmaster":{"type":"boolean","description":"Value of groupingmaster"},"digitaltpltype":{"type":"string","description":"Value of digitaltpltype","readOnly":true},"declinationof":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset.\n\n\n\n> Application base DAM object\n","readOnly":true},"digitaltpllogs":{"type":"string","description":"Value of digitaltpllogs","readOnly":true},"binaryorigin":{"type":"string","description":"Value of binaryorigin"},"rekousers":{"type":"array","description":"Data for rekousers.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"rekouserid":{"type":"string","description":"Value of rekouserid","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}}}},"$moreChildren_rekousers":{"type":"object","description":"Because the list of asset attached to the rekousers property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"contract":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for contract."},"focus_point_x":{"type":"string","description":"Value of focus_point_x"},"focus_point_y":{"type":"string","description":"Value of focus_point_y"},"brandguideline":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/asset/123/logo"}},"readOnly":true},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score","readOnly":true},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}},"readOnly":true},"$moreChildren_criteria":{"type":"object","description":"Because the list of asset attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following asset."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true}},"description":"Data for brandguideline.","readOnly":true},"brandscoredate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of brandscoredate","readOnly":true},"brandscorereport":{"type":"string","description":"Value of brandscorereport","readOnly":true},"brandscore":{"type":"integer","format":"int32","description":"Value of brandscore","readOnly":true},"gartnerdemo":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for gartner demo.","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"dteendrights":{"description":"Faces (form input field behavior according to the data)"},"source":{"description":"Faces (form input field behavior according to the data)"},"keywords":{"description":"Faces (form input field behavior according to the data)"},"photograph":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"assetformat":{"description":"Faces (form input field behavior according to the data)"},"width":{"description":"Faces (form input field behavior according to the data)"},"height":{"description":"Faces (form input field behavior according to the data)"},"duration":{"description":"Faces (form input field behavior according to the data)"},"clipped":{"description":"Faces (form input field behavior according to the data)"},"filesize":{"description":"Faces (form input field behavior according to the data)"},"colorspace":{"description":"Faces (form input field behavior according to the data)"},"nbpages":{"description":"Faces (form input field behavior according to the data)"},"copietravail":{"description":"Faces (form input field behavior according to the data)"},"uid":{"description":"Faces (form input field behavior according to the data)"},"version":{"description":"Faces (form input field behavior according to the data)"},"originalfilename":{"description":"Faces (form input field behavior according to the data)"},"resolution":{"description":"Faces (form input field behavior according to the data)"},"assetnature":{"description":"Faces (form input field behavior according to the data)"},"poster":{"description":"Faces (form input field behavior according to the data)"},"ai_caption":{"description":"Faces (form input field behavior according to the data)"},"righttype":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces":{"description":"Faces (form input field behavior according to the data)"},"ai_mainbg":{"description":"Faces (form input field behavior according to the data)"},"ai_mainfg":{"description":"Faces (form input field behavior according to the data)"},"authorizedchannel":{"description":"Faces (form input field behavior according to the data)"},"ai_faces":{"description":"Faces (form input field behavior according to the data)"},"shootingdate":{"description":"Faces (form input field behavior according to the data)"},"coverage":{"description":"Faces (form input field behavior according to the data)"},"folder":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"},"ai_concepts":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_baby":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_children":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_adult":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_senior":{"description":"Faces (form input field behavior according to the data)"},"nbentries":{"description":"Faces (form input field behavior according to the data)"},"blurhash":{"description":"Faces (form input field behavior according to the data)"},"ai_captionfr":{"description":"Faces (form input field behavior according to the data)"},"ai_captionde":{"description":"Faces (form input field behavior according to the data)"},"videoratio":{"description":"Faces (form input field behavior according to the data)"},"tmpsource":{"description":"Faces (form input field behavior according to the data)"},"langs":{"description":"Faces (form input field behavior according to the data)"},"location":{"description":"Faces (form input field behavior according to the data)"},"displayweight":{"description":"Faces (form input field behavior according to the data)"},"ai_celebrities":{"description":"Faces (form input field behavior according to the data)"},"ai_landmarks":{"description":"Faces (form input field behavior according to the data)"},"season":{"description":"Faces (form input field behavior according to the data)"},"imgbnksrc":{"description":"Faces (form input field behavior according to the data)"},"spaces":{"description":"Faces (form input field behavior according to the data)"},"portals":{"description":"Faces (form input field behavior according to the data)"},"brandassettype":{"description":"Faces (form input field behavior according to the data)"},"grouping":{"description":"Faces (form input field behavior according to the data)"},"groupingmaster":{"description":"Faces (form input field behavior according to the data)"},"digitaltpltype":{"description":"Faces (form input field behavior according to the data)"},"declinationof":{"description":"Faces (form input field behavior according to the data)"},"digitaltpllogs":{"description":"Faces (form input field behavior according to the data)"},"binaryorigin":{"description":"Faces (form input field behavior according to the data)"},"rekousers":{"description":"Faces (form input field behavior according to the data)"},"contract":{"description":"Faces (form input field behavior according to the data)"},"focus_point_x":{"description":"Faces (form input field behavior according to the data)"},"focus_point_y":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"brandscoredate":{"description":"Faces (form input field behavior according to the data)"},"brandscorereport":{"description":"Faces (form input field behavior according to the data)"},"brandscore":{"description":"Faces (form input field behavior according to the data)"},"gartnerdemo":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetauthor":{"type":"object","title":"photographer","description":"Data structure of resource photographer. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of last name"},"email":{"type":"string","description":"Value of email"},"externalid":{"type":"string","description":"Value of external id","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"email":{"description":"Faces (form input field behavior according to the data)"},"externalid":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetchannel":{"type":"object","title":"channel","description":"Data structure of resource channel. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetcolorspace":{"type":"object","title":"color space","description":"Data structure of resource color space. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"code":{"type":"string","description":"Value of code"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetcoverage":{"type":"object","title":"collection","description":"Data structure of resource collection. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"description":{"type":"string","description":"Value of description"},"descriptionfr":{"type":"string","description":"Value of description (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"descriptionde":{"type":"string","description":"Value of description (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetformat":{"type":"object","title":"orientation","description":"Data structure of resource orientation. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"namees":{"type":"string","description":"Value of name (Spanish)"},"code":{"type":"string","description":"Value of code"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetgeography":{"type":"object","title":"geographical thesaurus","description":"Data structure of resource geographical thesaurus. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"generic":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for geographical thesaurus."},"namefr":{"type":"string","description":"Value of name (FR)"},"synonym":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for geographical thesaurus."},"related":{"type":"array","description":"Data for geographical thesaurus.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_related":{"type":"object","description":"Because the list of geographical thesaurus attached to the geographical thesaurus property is limited (by the `maxchildren` parameter), this block allows to describe the geographical thesaurus obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of geographical thesaurus","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of geographical thesaurus","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following geographical thesaurus (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following geographical thesaurus."}}},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"generic":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"synonym":{"description":"Faces (form input field behavior according to the data)"},"related":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetgrouping":{"type":"object","title":"assetgrouping","description":"Data structure of resource assetgrouping. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"fixedmaster":{"type":"boolean","description":"Value of fixedmaster","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"fixedmaster":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetiaconcept":{"type":"object","title":"AI concepts","description":"Data structure of resource AI concepts. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of AI keyword"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetkeyword":{"type":"object","title":"keyword","description":"Data structure of resource keyword. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of keyword"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetlanguage":{"type":"object","title":"languages","description":"Data structure of resource languages. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"code":{"type":"string","description":"Value of code"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetnature":{"type":"object","title":"asset type","description":"Data structure of resource asset type. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"activated":{"type":"boolean","description":"Value of active","readOnly":true},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"primarytype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for asset type."},"code":{"type":"string","description":"Value of code"},"namees":{"type":"string","description":"Value of name (Spanish)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"activated":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"primarytype":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetrighttype":{"type":"object","title":"rights","description":"Data structure of resource rights. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)","writeOnly":true},"namees":{"type":"string","description":"Value of name (Spanish)","writeOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetseason":{"type":"object","title":"season","description":"Data structure of resource season. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)","writeOnly":true},"namede":{"type":"string","description":"Value of name (DE)","writeOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-assetvisibility":{"type":"object","title":"asset visibility","description":"Data structure of resource asset visibility. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-brandassettype":{"type":"object","title":"brand asset type","description":"Data structure of resource brand asset type. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-brandcenter":{"type":"object","title":"brand center","description":"Data structure of resource 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","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user.","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"namefr":{"type":"string","description":"Value of name (FR)"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123/binary"}}},"dteendrights":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of expiration date"},"keywords":{"type":"array","description":"Data for keyword.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of keyword","readOnly":true}}}},"$moreChildren_keywords":{"type":"object","description":"Because the list of brand center attached to the keyword property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"photograph":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of last name","readOnly":true}},"description":"Data for photographer."},"namede":{"type":"string","description":"Value of name (DE)"},"description":{"type":"string","description":"Value of caption"},"descriptionfr":{"type":"string","description":"Value of description (FR)"},"descriptionde":{"type":"string","description":"Value of description (DE)"},"assetformat":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for orientation.","readOnly":true},"width":{"type":"integer","format":"int32","description":"Value of width","readOnly":true},"height":{"type":"integer","format":"int32","description":"Value of height","readOnly":true},"duration":{"type":"number","format":"double","description":"Value of duration","readOnly":true},"clipped":{"type":"boolean","description":"Value of clipped","readOnly":true},"filesize":{"type":"number","format":"double","description":"Value of file size","readOnly":true},"colorspace":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for color space.","readOnly":true},"nbpages":{"type":"integer","format":"int32","description":"Value of page count","readOnly":true},"copietravail":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for 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","readOnly":true},"uid":{"type":"string","description":"Value of uid","readOnly":true},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true},"nameen":{"type":"string","description":"Value of name"},"descriptionen":{"type":"string","description":"Value of description"},"sha":{"type":"string","description":"Value of sha","readOnly":true},"phavg":{"type":"string","description":"Value of phavg","readOnly":true},"phdiff":{"type":"string","description":"Value of phdiff","readOnly":true},"originalfilename":{"type":"string","description":"Value of original file name"},"latitude":{"type":"number","format":"double","description":"Value of latitude","readOnly":true},"longitude":{"type":"number","format":"double","description":"Value of longitude","readOnly":true},"resolution":{"type":"string","description":"Value of resolution","readOnly":true},"assetnature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset type.","readOnly":true},"ai_tags":{"type":"array","description":"Data for keyword.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of keyword","readOnly":true}}},"readOnly":true},"$moreChildren_ai_tags":{"type":"object","description":"Because the list of brand center attached to the keyword property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"ai_caption":{"type":"string","description":"Value of AI-generated caption (EN)","readOnly":true},"righttype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for rights."},"ai_nbfaces":{"type":"integer","format":"int32","description":"Value of AI people count","readOnly":true},"ai_avgage":{"type":"integer","format":"int32","description":"Value of AI average age","readOnly":true},"ai_mainbg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"ai_mainfg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"authorizedchannel":{"type":"array","description":"Data for channel.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_authorizedchannel":{"type":"object","description":"Because the list of brand center attached to the channel property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"copyright":{"type":"string","description":"Value of copyright"},"ai_faces":{"type":"string","description":"Value of AI faces attributes","readOnly":true},"shootingdate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of shooting date"},"displayweight":{"type":"integer","format":"int32","description":"Value of featured assets"},"poster":{"type":"object","description":"Data for poster property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123/poster"}},"writeOnly":true},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for organization."},"nbentries":{"type":"integer","format":"int32","description":"Value of file count in zip archive","readOnly":true},"coverage":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for collection.","readOnly":true},"ai_concepts":{"type":"array","description":"Data for AI concepts.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of AI keyword","readOnly":true}}},"readOnly":true},"$moreChildren_ai_concepts":{"type":"object","description":"Because the list of brand center attached to the AI concepts property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"ai_nbfaces_baby":{"type":"integer","format":"int32","description":"Value of baby count","readOnly":true},"ai_nbfaces_children":{"type":"integer","format":"int32","description":"Value of children count","readOnly":true},"ai_nbfaces_adult":{"type":"integer","format":"int32","description":"Value of adult count","readOnly":true},"ai_nbfaces_senior":{"type":"integer","format":"int32","description":"Value of senior people count","readOnly":true},"blurhash":{"type":"string","description":"Value of blurhash","readOnly":true},"tmpsource":{"type":"string","description":"Value of tmpsource","readOnly":true},"visibility":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset visibility."},"mediaid":{"type":"string","description":"Value of mediaid","readOnly":true},"imgbnksrc":{"type":"string","description":"Value of image bank source","readOnly":true},"alloweddomains":{"type":"array","description":"Data for domain names authorized for streaming.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_alloweddomains":{"type":"object","description":"Because the list of brand center attached to the domain names authorized for streaming property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"spaces":{"type":"array","description":"Data for space.\n\n\n\n> This object represents a collaborative space.\n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_spaces":{"type":"object","description":"Because the list of brand center attached to the space property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"portals":{"type":"array","description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_portals":{"type":"object","description":"Because the list of brand center attached to the portals property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"brandassettype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for brand asset type."},"grouping":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for grouping."},"groupingmaster":{"type":"boolean","description":"Value of groupingmaster"},"digitaltpltype":{"type":"string","description":"Value of digitaltpltype","readOnly":true},"digitaltpllogs":{"type":"string","description":"Value of digitaltpllogs","readOnly":true},"declinationof":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for 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","readOnly":true},"binaryorigin":{"type":"string","description":"Value of binaryorigin"},"rekousers":{"type":"array","description":"Data for rekousers.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"rekouserid":{"type":"string","description":"Value of rekouserid","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}}}},"$moreChildren_rekousers":{"type":"object","description":"Because the list of brand center attached to the rekousers property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"brandguideline":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandcenter/123/logo"}},"readOnly":true},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score","readOnly":true},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}},"readOnly":true},"$moreChildren_criteria":{"type":"object","description":"Because the list of brand center attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the brand center obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brand center","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brand center","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brand center (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brand center."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true}},"description":"Data for brandguideline.","readOnly":true},"brandscoredate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of brandscoredate","readOnly":true},"brandscore":{"type":"integer","format":"int32","description":"Value of brandscore","readOnly":true},"brandscorereport":{"type":"string","description":"Value of brandscorereport","readOnly":true},"focus_point_x":{"type":"string","description":"Value of focus_point_x"},"focus_point_y":{"type":"string","description":"Value of focus_point_y"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"dteendrights":{"description":"Faces (form input field behavior according to the data)"},"keywords":{"description":"Faces (form input field behavior according to the data)"},"photograph":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"assetformat":{"description":"Faces (form input field behavior according to the data)"},"width":{"description":"Faces (form input field behavior according to the data)"},"height":{"description":"Faces (form input field behavior according to the data)"},"duration":{"description":"Faces (form input field behavior according to the data)"},"clipped":{"description":"Faces (form input field behavior according to the data)"},"filesize":{"description":"Faces (form input field behavior according to the data)"},"colorspace":{"description":"Faces (form input field behavior according to the data)"},"nbpages":{"description":"Faces (form input field behavior according to the data)"},"copietravail":{"description":"Faces (form input field behavior according to the data)"},"uid":{"description":"Faces (form input field behavior according to the data)"},"version":{"description":"Faces (form input field behavior according to the data)"},"nameen":{"description":"Faces (form input field behavior according to the data)"},"descriptionen":{"description":"Faces (form input field behavior according to the data)"},"sha":{"description":"Faces (form input field behavior according to the data)"},"phavg":{"description":"Faces (form input field behavior according to the data)"},"phdiff":{"description":"Faces (form input field behavior according to the data)"},"originalfilename":{"description":"Faces (form input field behavior according to the data)"},"latitude":{"description":"Faces (form input field behavior according to the data)"},"longitude":{"description":"Faces (form input field behavior according to the data)"},"resolution":{"description":"Faces (form input field behavior according to the data)"},"assetnature":{"description":"Faces (form input field behavior according to the data)"},"ai_tags":{"description":"Faces (form input field behavior according to the data)"},"ai_caption":{"description":"Faces (form input field behavior according to the data)"},"righttype":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces":{"description":"Faces (form input field behavior according to the data)"},"ai_avgage":{"description":"Faces (form input field behavior according to the data)"},"ai_mainbg":{"description":"Faces (form input field behavior according to the data)"},"ai_mainfg":{"description":"Faces (form input field behavior according to the data)"},"authorizedchannel":{"description":"Faces (form input field behavior according to the data)"},"copyright":{"description":"Faces (form input field behavior according to the data)"},"ai_faces":{"description":"Faces (form input field behavior according to the data)"},"shootingdate":{"description":"Faces (form input field behavior according to the data)"},"displayweight":{"description":"Faces (form input field behavior according to the data)"},"poster":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"},"nbentries":{"description":"Faces (form input field behavior according to the data)"},"coverage":{"description":"Faces (form input field behavior according to the data)"},"ai_concepts":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_baby":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_children":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_adult":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_senior":{"description":"Faces (form input field behavior according to the data)"},"blurhash":{"description":"Faces (form input field behavior according to the data)"},"tmpsource":{"description":"Faces (form input field behavior according to the data)"},"visibility":{"description":"Faces (form input field behavior according to the data)"},"mediaid":{"description":"Faces (form input field behavior according to the data)"},"imgbnksrc":{"description":"Faces (form input field behavior according to the data)"},"alloweddomains":{"description":"Faces (form input field behavior according to the data)"},"spaces":{"description":"Faces (form input field behavior according to the data)"},"portals":{"description":"Faces (form input field behavior according to the data)"},"brandassettype":{"description":"Faces (form input field behavior according to the data)"},"grouping":{"description":"Faces (form input field behavior according to the data)"},"groupingmaster":{"description":"Faces (form input field behavior according to the data)"},"digitaltpltype":{"description":"Faces (form input field behavior according to the data)"},"digitaltpllogs":{"description":"Faces (form input field behavior according to the data)"},"declinationof":{"description":"Faces (form input field behavior according to the data)"},"binaryorigin":{"description":"Faces (form input field behavior according to the data)"},"rekousers":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"brandscoredate":{"description":"Faces (form input field behavior according to the data)"},"brandscore":{"description":"Faces (form input field behavior according to the data)"},"brandscorereport":{"description":"Faces (form input field behavior according to the data)"},"focus_point_x":{"description":"Faces (form input field behavior according to the data)"},"focus_point_y":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-brandcriterion":{"type":"object","title":"brandcriterion","description":"Data structure of resource brandcriterion. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"category":{"type":"string","description":"Value of category"},"label":{"type":"string","description":"Value of label"},"description":{"type":"string","description":"Value of description"},"importance":{"type":"string","description":"Value of importance"},"weight":{"type":"integer","format":"int32","description":"Value of weight"},"source":{"type":"string","description":"Value of source file"},"styletoken":{"type":"string","description":"Value of styletoken"},"avoidtoken":{"type":"string","description":"Value of avoidtoken"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"category":{"description":"Faces (form input field behavior according to the data)"},"label":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"importance":{"description":"Faces (form input field behavior according to the data)"},"weight":{"description":"Faces (form input field behavior according to the data)"},"source":{"description":"Faces (form input field behavior according to the data)"},"styletoken":{"description":"Faces (form input field behavior according to the data)"},"avoidtoken":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-brandguideline":{"type":"object","title":"brandguideline","description":"Data structure of resource brandguideline. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandguideline/123/logo"}}},"references":{"type":"array","description":"Data for references.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_references":{"type":"object","description":"Because the list of brandguideline attached to the references property is limited (by the `maxchildren` parameter), this block allows to describe the brandguideline obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brandguideline","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brandguideline","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brandguideline (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brandguideline."}}},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score"},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_criteria":{"type":"object","description":"Because the list of brandguideline attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the brandguideline obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of brandguideline","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of brandguideline","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following brandguideline (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following brandguideline."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true},"copietravail":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for working copy.","readOnly":true},"uid":{"type":"string","description":"Value of uid","readOnly":true},"generationstatus":{"type":"string","description":"Value of generationstatus","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"logo":{"description":"Faces (form input field behavior according to the data)"},"references":{"description":"Faces (form input field behavior according to the data)"},"threshold":{"description":"Faces (form input field behavior according to the data)"},"criteria":{"description":"Faces (form input field behavior according to the data)"},"version":{"description":"Faces (form input field behavior according to the data)"},"copietravail":{"description":"Faces (form input field behavior according to the data)"},"uid":{"description":"Faces (form input field behavior according to the data)"},"generationstatus":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-brandreference":{"type":"object","title":"brandreference","description":"Data structure of resource brandreference. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"type":{"type":"string","description":"Value of type"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/brandreference/123/binary"}}},"url":{"type":"string","description":"Value of url"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"type":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"url":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-collaborativespace":{"type":"object","title":"collaborativespace","description":"Data structure of resource collaborativespace. \n\n\n\n> This object represents a collaborative space.\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"owner":{"properties":{"name":{"type":"string","description":"Value of display name","readOnly":true},"email":{"type":"string","description":"Value of email","readOnly":true},"avatar":{"type":"object","description":"Data for avatar property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123/avatar"}},"readOnly":true},"lastname":{"type":"string","description":"Value of last name","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}},"description":"Data for user."},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"description":{"type":"string","description":"Value of description"},"boardid":{"type":"string","description":"Value of boardid"},"team":{"type":"array","description":"Data for user.","items":{"properties":{"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for users workflow."},"name":{"type":"string","description":"Value of display name","readOnly":true},"email":{"type":"string","description":"Value of email","readOnly":true},"avatar":{"type":"object","description":"Data for avatar property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123/avatar"}},"readOnly":true},"lastname":{"type":"string","description":"Value of last name","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}}}},"$moreChildren_team":{"type":"object","description":"Because the list of collaborativespace attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the collaborativespace obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of collaborativespace","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of collaborativespace","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following collaborativespace (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following collaborativespace."}}},"job":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for job.","readOnly":true},"brieffiles":{"type":"array","description":"Data for work documents.","items":{"properties":{"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for user."},"brieffile":{"type":"object","description":"Data for briefing property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123/brieffile"}},"readOnly":true},"brieflink":{"type":"string","description":"Value of brieflink","readOnly":true}}}},"$moreChildren_brieffiles":{"type":"object","description":"Because the list of collaborativespace attached to the work documents property is limited (by the `maxchildren` parameter), this block allows to describe the collaborativespace obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of collaborativespace","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of collaborativespace","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following collaborativespace (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following collaborativespace."}}},"targetlibrary":{"type":"string","description":"Value of asset library (defaut)"},"brandguideline":{"properties":{"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/collaborativespace/123/logo"}},"readOnly":true},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score","readOnly":true},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_criteria":{"type":"object","description":"Because the list of collaborativespace attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the collaborativespace obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of collaborativespace","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of collaborativespace","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following collaborativespace (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following collaborativespace."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true}},"description":"Data for brand guidelines."},"teamgroups":{"type":"array","description":"Data for teamgroups.","items":{"properties":{"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for status."},"viewers":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_viewers":{"type":"object","description":"Because the list of collaborativespace attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the collaborativespace obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of collaborativespace","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of collaborativespace","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following collaborativespace (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following collaborativespace."}}},"type":{"type":"string","description":"Value of type","readOnly":true}}}},"$moreChildren_teamgroups":{"type":"object","description":"Because the list of collaborativespace attached to the teamgroups property is limited (by the `maxchildren` parameter), this block allows to describe the collaborativespace obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of collaborativespace","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of collaborativespace","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following collaborativespace (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following collaborativespace."}}},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"boardid":{"description":"Faces (form input field behavior according to the data)"},"team":{"description":"Faces (form input field behavior according to the data)"},"job":{"description":"Faces (form input field behavior according to the data)"},"brieffiles":{"description":"Faces (form input field behavior according to the data)"},"targetlibrary":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"teamgroups":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-contract":{"type":"object","title":"contract","description":"Data structure of resource contract. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"namees":{"type":"string","description":"Value of name (ES)"},"attachedfile":{"type":"object","description":"Data for attached file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/contract/123/attachedfile"}}},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"},"attachedfile":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-country":{"type":"object","title":"country","description":"Data structure of resource country. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"code":{"type":"string","description":"Value of code"},"code_num":{"type":"integer","format":"int32","description":"Value of code_num"},"code_iso3":{"type":"string","description":"Value of code_iso3"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"code_num":{"description":"Faces (form input field behavior according to the data)"},"code_iso3":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-cspsource":{"type":"object","title":"cspsource","description":"Data structure of resource cspsource. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-folder":{"type":"object","title":"folder","description":"Data structure of resource folder. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"parentfolder":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for folder."},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"parentfolder":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-gartnerdemo":{"type":"object","title":"gartner demo","description":"Data structure of resource gartner demo. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"namees":{"type":"string","description":"Value of name (ES)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-genaitempimage":{"type":"object","title":"genaitempimage","description":"Data structure of resource genaitempimage. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/genaitempimage/123/binary"}}},"brandguideline":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for brandguideline."},"brandscore":{"type":"integer","format":"int32","description":"Value of brandscore"},"brandscoredate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of brandscoredate"},"brandscorereport":{"type":"string","description":"Value of brandscorereport"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"brandscore":{"description":"Faces (form input field behavior according to the data)"},"brandscoredate":{"description":"Faces (form input field behavior according to the data)"},"brandscorereport":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-lang":{"type":"object","title":"language","description":"Data structure of resource language. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name"},"activated":{"type":"boolean","description":"Value of active","readOnly":true},"code":{"type":"string","description":"Value of code"},"icon":{"type":"object","description":"Data for icon property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/lang/123/icon"}}},"originalname":{"type":"string","description":"Value of original name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"activated":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"icon":{"description":"Faces (form input field behavior according to the data)"},"originalname":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-legacy":{"type":"object","title":"legacy","description":"Data structure of resource 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","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user.","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123/binary"}}},"dteendrights":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of expiration date"},"keywords":{"type":"array","description":"Data for keyword.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of keyword","readOnly":true}}}},"$moreChildren_keywords":{"type":"object","description":"Because the list of legacy attached to the keyword property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"photograph":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of last name","readOnly":true}},"description":"Data for photographer."},"namede":{"type":"string","description":"Value of name (DE)"},"description":{"type":"string","description":"Value of caption"},"descriptionfr":{"type":"string","description":"Value of caption (FR)"},"descriptionde":{"type":"string","description":"Value of caption (DE)"},"assetformat":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for orientation.","readOnly":true},"width":{"type":"integer","format":"int32","description":"Value of width","readOnly":true},"height":{"type":"integer","format":"int32","description":"Value of height","readOnly":true},"duration":{"type":"number","format":"double","description":"Value of duration","readOnly":true},"clipped":{"type":"boolean","description":"Value of clipped","readOnly":true},"filesize":{"type":"number","format":"double","description":"Value of file size","readOnly":true},"colorspace":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for color space.","readOnly":true},"nbpages":{"type":"integer","format":"int32","description":"Value of page count","readOnly":true},"copietravail":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for 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","readOnly":true},"uid":{"type":"string","description":"Value of uid","readOnly":true},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true},"originalfilename":{"type":"string","description":"Value of original file name","readOnly":true},"resolution":{"type":"string","description":"Value of resolution","readOnly":true},"assetnature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset type.","readOnly":true},"poster":{"type":"object","description":"Data for poster property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123/poster"}}},"ai_caption":{"type":"string","description":"Value of AI-generated caption (EN)","readOnly":true},"righttype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for rights."},"ai_nbfaces":{"type":"integer","format":"int32","description":"Value of AI people count","readOnly":true},"ai_mainbg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"ai_mainfg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"authorizedchannel":{"type":"array","description":"Data for channel.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_authorizedchannel":{"type":"object","description":"Because the list of legacy attached to the channel property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"location":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for geographical thesaurus."},"copyright":{"type":"string","description":"Value of copyright"},"ai_faces":{"type":"string","description":"Value of AI faces attributes","readOnly":true},"shootingdate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of shooting date"},"displayweight":{"type":"integer","format":"int32","description":"Value of featured assets"},"coverage":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for collection."},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for organization."},"ai_celebrities":{"type":"array","description":"Data for celebrity.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_celebrities":{"type":"object","description":"Because the list of legacy attached to the celebrity property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"ai_landmarks":{"type":"array","description":"Data for landmark.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_landmarks":{"type":"object","description":"Because the list of legacy attached to the landmark property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"ai_concepts":{"type":"array","description":"Data for AI concepts.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of AI keyword","readOnly":true}}},"readOnly":true},"$moreChildren_ai_concepts":{"type":"object","description":"Because the list of legacy attached to the AI concepts property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"ai_nbfaces_baby":{"type":"integer","format":"int32","description":"Value of baby count","readOnly":true},"ai_nbfaces_children":{"type":"integer","format":"int32","description":"Value of children count","readOnly":true},"ai_nbfaces_adult":{"type":"integer","format":"int32","description":"Value of adult count","readOnly":true},"ai_nbfaces_senior":{"type":"integer","format":"int32","description":"Value of senior people count","readOnly":true},"nbentries":{"type":"integer","format":"int32","description":"Value of file count in zip archive","readOnly":true},"visibility":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset visibility."},"blurhash":{"type":"string","description":"Value of blurhash","readOnly":true},"ai_captionfr":{"type":"string","description":"Value of AI caption (FR)","readOnly":true},"videoratio":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for video ratio.","readOnly":true},"tmpsource":{"type":"string","description":"Value of tmpsource","readOnly":true},"productionyear":{"type":"integer","format":"int32","description":"Value of production year"},"conservationstate":{"type":"string","description":"Value of conservation state"},"dteentrycollection":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of date of entry in the collections"},"mediaid":{"type":"string","description":"Value of mediaid","readOnly":true},"imgbnksrc":{"type":"string","description":"Value of image bank source","readOnly":true},"alloweddomains":{"type":"array","description":"Data for domain names authorized for streaming.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_alloweddomains":{"type":"object","description":"Because the list of legacy attached to the domain names authorized for streaming property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"spaces":{"type":"array","description":"Data for space.\n\n\n\n> This object represents a collaborative space.\n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_spaces":{"type":"object","description":"Because the list of legacy attached to the space property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"portals":{"type":"array","description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_portals":{"type":"object","description":"Because the list of legacy attached to the portals property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"groupingmaster":{"type":"boolean","description":"Value of groupingmaster"},"grouping":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for grouping."},"digitaltpltype":{"type":"string","description":"Value of digitaltpltype","readOnly":true},"digitaltpllogs":{"type":"string","description":"Value of digitaltpllogs","readOnly":true},"declinationof":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for 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","readOnly":true},"binaryorigin":{"type":"string","description":"Value of binaryorigin"},"rekousers":{"type":"array","description":"Data for rekousers.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"rekouserid":{"type":"string","description":"Value of rekouserid","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}}}},"$moreChildren_rekousers":{"type":"object","description":"Because the list of legacy attached to the rekousers property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"brandguideline":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/legacy/123/logo"}},"readOnly":true},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score","readOnly":true},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}},"readOnly":true},"$moreChildren_criteria":{"type":"object","description":"Because the list of legacy attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the legacy obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of legacy","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of legacy","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following legacy (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following legacy."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true}},"description":"Data for brandguideline.","readOnly":true},"brandscoredate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of brandscoredate","readOnly":true},"brandscorereport":{"type":"string","description":"Value of brandscorereport","readOnly":true},"brandscore":{"type":"integer","format":"int32","description":"Value of brandscore","readOnly":true},"focus_point_x":{"type":"string","description":"Value of focus_point_x"},"focus_point_y":{"type":"string","description":"Value of focus_point_y"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"dteendrights":{"description":"Faces (form input field behavior according to the data)"},"keywords":{"description":"Faces (form input field behavior according to the data)"},"photograph":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"assetformat":{"description":"Faces (form input field behavior according to the data)"},"width":{"description":"Faces (form input field behavior according to the data)"},"height":{"description":"Faces (form input field behavior according to the data)"},"duration":{"description":"Faces (form input field behavior according to the data)"},"clipped":{"description":"Faces (form input field behavior according to the data)"},"filesize":{"description":"Faces (form input field behavior according to the data)"},"colorspace":{"description":"Faces (form input field behavior according to the data)"},"nbpages":{"description":"Faces (form input field behavior according to the data)"},"copietravail":{"description":"Faces (form input field behavior according to the data)"},"uid":{"description":"Faces (form input field behavior according to the data)"},"version":{"description":"Faces (form input field behavior according to the data)"},"originalfilename":{"description":"Faces (form input field behavior according to the data)"},"resolution":{"description":"Faces (form input field behavior according to the data)"},"assetnature":{"description":"Faces (form input field behavior according to the data)"},"poster":{"description":"Faces (form input field behavior according to the data)"},"ai_caption":{"description":"Faces (form input field behavior according to the data)"},"righttype":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces":{"description":"Faces (form input field behavior according to the data)"},"ai_mainbg":{"description":"Faces (form input field behavior according to the data)"},"ai_mainfg":{"description":"Faces (form input field behavior according to the data)"},"authorizedchannel":{"description":"Faces (form input field behavior according to the data)"},"location":{"description":"Faces (form input field behavior according to the data)"},"copyright":{"description":"Faces (form input field behavior according to the data)"},"ai_faces":{"description":"Faces (form input field behavior according to the data)"},"shootingdate":{"description":"Faces (form input field behavior according to the data)"},"displayweight":{"description":"Faces (form input field behavior according to the data)"},"coverage":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"},"ai_celebrities":{"description":"Faces (form input field behavior according to the data)"},"ai_landmarks":{"description":"Faces (form input field behavior according to the data)"},"ai_concepts":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_baby":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_children":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_adult":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_senior":{"description":"Faces (form input field behavior according to the data)"},"nbentries":{"description":"Faces (form input field behavior according to the data)"},"visibility":{"description":"Faces (form input field behavior according to the data)"},"blurhash":{"description":"Faces (form input field behavior according to the data)"},"ai_captionfr":{"description":"Faces (form input field behavior according to the data)"},"videoratio":{"description":"Faces (form input field behavior according to the data)"},"tmpsource":{"description":"Faces (form input field behavior according to the data)"},"productionyear":{"description":"Faces (form input field behavior according to the data)"},"conservationstate":{"description":"Faces (form input field behavior according to the data)"},"dteentrycollection":{"description":"Faces (form input field behavior according to the data)"},"mediaid":{"description":"Faces (form input field behavior according to the data)"},"imgbnksrc":{"description":"Faces (form input field behavior according to the data)"},"alloweddomains":{"description":"Faces (form input field behavior according to the data)"},"spaces":{"description":"Faces (form input field behavior according to the data)"},"portals":{"description":"Faces (form input field behavior according to the data)"},"groupingmaster":{"description":"Faces (form input field behavior according to the data)"},"grouping":{"description":"Faces (form input field behavior according to the data)"},"digitaltpltype":{"description":"Faces (form input field behavior according to the data)"},"digitaltpllogs":{"description":"Faces (form input field behavior according to the data)"},"declinationof":{"description":"Faces (form input field behavior according to the data)"},"binaryorigin":{"description":"Faces (form input field behavior according to the data)"},"rekousers":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"brandscoredate":{"description":"Faces (form input field behavior according to the data)"},"brandscorereport":{"description":"Faces (form input field behavior according to the data)"},"brandscore":{"description":"Faces (form input field behavior according to the data)"},"focus_point_x":{"description":"Faces (form input field behavior according to the data)"},"focus_point_y":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-organization":{"type":"object","title":"organization","description":"Data structure of resource organization. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"parentorg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for organization."},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"parentorg":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-pimasset":{"type":"object","title":"product asset","description":"Data structure of resource product asset. \n\n\n\n> Product asset for 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","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123/binary"}}},"dteendrights":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of expiration date"},"source":{"type":"object","description":"Data for source file property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123/source"}},"readOnly":true},"keywords":{"type":"array","description":"Data for keyword.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of keyword","readOnly":true}}}},"$moreChildren_keywords":{"type":"object","description":"Because the list of product asset attached to the keyword property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"photograph":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of last name","readOnly":true}},"description":"Data for photographer."},"namede":{"type":"string","description":"Value of name (DE)"},"description":{"type":"string","description":"Value of caption"},"descriptionfr":{"type":"string","description":"Value of description (FR)"},"descriptionde":{"type":"string","description":"Value of description (DE)"},"assetformat":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for orientation.","readOnly":true},"width":{"type":"integer","format":"int32","description":"Value of width","readOnly":true},"height":{"type":"integer","format":"int32","description":"Value of height","readOnly":true},"duration":{"type":"number","format":"double","description":"Value of duration","readOnly":true},"clipped":{"type":"boolean","description":"Value of clipped","readOnly":true},"filesize":{"type":"number","format":"double","description":"Value of file size","readOnly":true},"colorspace":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for color space.","readOnly":true},"nbpages":{"type":"integer","format":"int32","description":"Value of page count","readOnly":true},"copietravail":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for product asset.\n\n\n\n> Product asset for 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","readOnly":true},"uid":{"type":"string","description":"Value of uid","readOnly":true},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true},"originalfilename":{"type":"string","description":"Value of original file name","readOnly":true},"resolution":{"type":"string","description":"Value of resolution","readOnly":true},"assetnature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset type.","readOnly":true},"poster":{"type":"object","description":"Data for poster property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123/poster"}}},"ai_caption":{"type":"string","description":"Value of AI-generated caption (EN)","readOnly":true},"righttype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for rights."},"ai_nbfaces":{"type":"integer","format":"int32","description":"Value of AI people count","readOnly":true},"ai_mainbg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"ai_mainfg":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for AI colors.\n\n\n\n> *AI* / Main color","readOnly":true},"authorizedchannel":{"type":"array","description":"Data for channel.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_authorizedchannel":{"type":"object","description":"Because the list of product asset attached to the channel property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"copyright":{"type":"string","description":"Value of copyright"},"ai_faces":{"type":"string","description":"Value of AI faces attributes","readOnly":true},"shootingdate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of shooting date"},"displayweight":{"type":"integer","format":"int32","description":"Value of featured assets"},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for organization."},"ai_celebrities":{"type":"array","description":"Data for celebrity.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_celebrities":{"type":"object","description":"Because the list of product asset attached to the celebrity property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"ai_landmarks":{"type":"array","description":"Data for landmark.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_ai_landmarks":{"type":"object","description":"Because the list of product asset attached to the landmark property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"ai_concepts":{"type":"array","description":"Data for AI concepts.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of AI keyword","readOnly":true}}},"readOnly":true},"$moreChildren_ai_concepts":{"type":"object","description":"Because the list of product asset attached to the AI concepts property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"mediaid":{"type":"string","description":"Value of mediaid","readOnly":true},"ai_nbfaces_baby":{"type":"integer","format":"int32","description":"Value of baby count","readOnly":true},"ai_nbfaces_children":{"type":"integer","format":"int32","description":"Value of children count","readOnly":true},"ai_nbfaces_adult":{"type":"integer","format":"int32","description":"Value of adult count","readOnly":true},"ai_nbfaces_senior":{"type":"integer","format":"int32","description":"Value of senior people count","readOnly":true},"nbentries":{"type":"integer","format":"int32","description":"Value of file count in zip archive","readOnly":true},"visibility":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for asset visibility."},"blurhash":{"type":"string","description":"Value of blurhash","readOnly":true},"ai_captionfr":{"type":"string","description":"Value of AI caption (FR)","readOnly":true},"videoratio":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for video ratio.","readOnly":true},"tmpsource":{"type":"string","description":"Value of tmpsource","readOnly":true},"productassettype":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for product asset type."},"imgbnksrc":{"type":"string","description":"Value of image bank source","readOnly":true},"alloweddomains":{"type":"array","description":"Data for domain names authorized for streaming.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_alloweddomains":{"type":"object","description":"Because the list of product asset attached to the domain names authorized for streaming property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"season":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for season."},"spaces":{"type":"array","description":"Data for space.\n\n\n\n> This object represents a collaborative space.\n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_spaces":{"type":"object","description":"Because the list of product asset attached to the space property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"portals":{"type":"array","description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_portals":{"type":"object","description":"Because the list of product asset attached to the portals property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"grouping":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for grouping."},"groupingmaster":{"type":"boolean","description":"Value of groupingmaster"},"vincent":{"type":"array","description":"Data for vincent.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}},"readOnly":true},"$moreChildren_vincent":{"type":"object","description":"Because the list of product asset attached to the vincent property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"digitaltpltype":{"type":"string","description":"Value of digitaltpltype","readOnly":true},"digitaltpllogs":{"type":"string","description":"Value of digitaltpllogs","readOnly":true},"declinationof":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for product asset.\n\n\n\n> Product asset for 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","readOnly":true},"binaryorigin":{"type":"string","description":"Value of binaryorigin"},"rekousers":{"type":"array","description":"Data for rekousers.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"rekouserid":{"type":"string","description":"Value of rekouserid","readOnly":true},"firstname":{"type":"string","description":"Value of first name","readOnly":true}}}},"$moreChildren_rekousers":{"type":"object","description":"Because the list of product asset attached to the rekousers property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"brandscoredate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of brandscoredate","readOnly":true},"brandguideline":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/pimasset/123/logo"}},"readOnly":true},"threshold":{"type":"integer","format":"int32","description":"Value of minimum score","readOnly":true},"criteria":{"type":"array","description":"Data for criteria.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}},"readOnly":true},"$moreChildren_criteria":{"type":"object","description":"Because the list of product asset attached to the criteria property is limited (by the `maxchildren` parameter), this block allows to describe the product asset obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product asset","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product asset","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product asset (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product asset."}}},"version":{"type":"integer","format":"int32","description":"Value of version","readOnly":true}},"description":"Data for brandguideline.","readOnly":true},"brandscorereport":{"type":"string","description":"Value of brandscorereport","readOnly":true},"brandscore":{"type":"integer","format":"int32","description":"Value of brandscore","readOnly":true},"focus_point_y":{"type":"string","description":"Value of focus_point_y"},"focus_point_x":{"type":"string","description":"Value of focus_point_x"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"binary":{"description":"Faces (form input field behavior according to the data)"},"dteendrights":{"description":"Faces (form input field behavior according to the data)"},"source":{"description":"Faces (form input field behavior according to the data)"},"keywords":{"description":"Faces (form input field behavior according to the data)"},"photograph":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"assetformat":{"description":"Faces (form input field behavior according to the data)"},"width":{"description":"Faces (form input field behavior according to the data)"},"height":{"description":"Faces (form input field behavior according to the data)"},"duration":{"description":"Faces (form input field behavior according to the data)"},"clipped":{"description":"Faces (form input field behavior according to the data)"},"filesize":{"description":"Faces (form input field behavior according to the data)"},"colorspace":{"description":"Faces (form input field behavior according to the data)"},"nbpages":{"description":"Faces (form input field behavior according to the data)"},"copietravail":{"description":"Faces (form input field behavior according to the data)"},"uid":{"description":"Faces (form input field behavior according to the data)"},"version":{"description":"Faces (form input field behavior according to the data)"},"originalfilename":{"description":"Faces (form input field behavior according to the data)"},"resolution":{"description":"Faces (form input field behavior according to the data)"},"assetnature":{"description":"Faces (form input field behavior according to the data)"},"poster":{"description":"Faces (form input field behavior according to the data)"},"ai_caption":{"description":"Faces (form input field behavior according to the data)"},"righttype":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces":{"description":"Faces (form input field behavior according to the data)"},"ai_mainbg":{"description":"Faces (form input field behavior according to the data)"},"ai_mainfg":{"description":"Faces (form input field behavior according to the data)"},"authorizedchannel":{"description":"Faces (form input field behavior according to the data)"},"copyright":{"description":"Faces (form input field behavior according to the data)"},"ai_faces":{"description":"Faces (form input field behavior according to the data)"},"shootingdate":{"description":"Faces (form input field behavior according to the data)"},"displayweight":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"},"ai_celebrities":{"description":"Faces (form input field behavior according to the data)"},"ai_landmarks":{"description":"Faces (form input field behavior according to the data)"},"ai_concepts":{"description":"Faces (form input field behavior according to the data)"},"mediaid":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_baby":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_children":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_adult":{"description":"Faces (form input field behavior according to the data)"},"ai_nbfaces_senior":{"description":"Faces (form input field behavior according to the data)"},"nbentries":{"description":"Faces (form input field behavior according to the data)"},"visibility":{"description":"Faces (form input field behavior according to the data)"},"blurhash":{"description":"Faces (form input field behavior according to the data)"},"ai_captionfr":{"description":"Faces (form input field behavior according to the data)"},"videoratio":{"description":"Faces (form input field behavior according to the data)"},"tmpsource":{"description":"Faces (form input field behavior according to the data)"},"productassettype":{"description":"Faces (form input field behavior according to the data)"},"imgbnksrc":{"description":"Faces (form input field behavior according to the data)"},"alloweddomains":{"description":"Faces (form input field behavior according to the data)"},"season":{"description":"Faces (form input field behavior according to the data)"},"spaces":{"description":"Faces (form input field behavior according to the data)"},"portals":{"description":"Faces (form input field behavior according to the data)"},"grouping":{"description":"Faces (form input field behavior according to the data)"},"groupingmaster":{"description":"Faces (form input field behavior according to the data)"},"vincent":{"description":"Faces (form input field behavior according to the data)"},"digitaltpltype":{"description":"Faces (form input field behavior according to the data)"},"digitaltpllogs":{"description":"Faces (form input field behavior according to the data)"},"declinationof":{"description":"Faces (form input field behavior according to the data)"},"binaryorigin":{"description":"Faces (form input field behavior according to the data)"},"rekousers":{"description":"Faces (form input field behavior according to the data)"},"brandscoredate":{"description":"Faces (form input field behavior according to the data)"},"brandguideline":{"description":"Faces (form input field behavior according to the data)"},"brandscorereport":{"description":"Faces (form input field behavior according to the data)"},"brandscore":{"description":"Faces (form input field behavior according to the data)"},"focus_point_y":{"description":"Faces (form input field behavior according to the data)"},"focus_point_x":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-pimassettype":{"type":"object","title":"product asset type","description":"Data structure of resource product asset type. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-pkgassetzipdownload":{"type":"object","title":"pkgassetzipdownload","description":"Data structure of resource pkgassetzipdownload. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"data":{"type":"string","description":"Value of data"},"expires":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of expires"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"data":{"description":"Faces (form input field behavior according to the data)"},"expires":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-portal":{"type":"object","title":"portals","description":"Data structure of resource portals. \n\n\n\n> The base structure of the portals functionality. \n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user.","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"activated":{"type":"boolean","description":"Value of active","readOnly":true},"portal":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"description":{"type":"string","description":"Value of description"},"descriptionfr":{"type":"string","description":"Value of description (FR)"},"descriptionde":{"type":"string","description":"Value of description (DE)"},"position":{"type":"integer","format":"int32","description":"Value of position"},"state":{"type":"string","description":"Value of state"},"firstitems":{"type":"string","description":"Value of firstitems"},"team":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}}}},"$moreChildren_team":{"type":"object","description":"Because the list of portals attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"viewers":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}}}},"$moreChildren_viewers":{"type":"object","description":"Because the list of portals attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"logo":{"type":"object","description":"Data for logo property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123/logo"}}},"cover":{"type":"object","description":"Data for banner property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123/cover"}}},"descriptionhtml":{"type":"string","format":"html","description":"Value of description"},"descriptionhtmlfr":{"type":"string","format":"html","description":"Value of description (FR)"},"descriptionhtmlde":{"type":"string","format":"html","description":"Value of description (DE)"},"private":{"type":"boolean","description":"Value of private"},"newestitems":{"type":"string","description":"Value of newestitems"},"visibility":{"type":"string","description":"Value of visibility"},"subtitle":{"type":"string","description":"Value of subtitle"},"subtitlefr":{"type":"string","description":"Value of subtitle (FR)"},"subtitlede":{"type":"string","description":"Value of subtitle (DE)"},"bookmarks":{"type":"array","description":"Data for bookmarks.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"type":{"type":"string","description":"Value of type","readOnly":true},"portal":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n"},"cart":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for cart."},"link":{"type":"string","description":"Value of URL","readOnly":true},"position":{"type":"integer","format":"int32","description":"Value of position","readOnly":true},"logo":{"type":"object","description":"Data for custom thumbnail property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portal/123/logo"}},"readOnly":true}}}},"$moreChildren_bookmarks":{"type":"object","description":"Because the list of portals attached to the bookmarks property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"portaltheme":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for portal theme."},"teamgroups":{"type":"array","description":"Data for teamgroups.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for status."},"name":{"type":"string","description":"Value of name","readOnly":true},"viewers":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_viewers":{"type":"object","description":"Because the list of portals attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"type":{"type":"string","description":"Value of type","readOnly":true}}}},"$moreChildren_teamgroups":{"type":"object","description":"Because the list of portals attached to the teamgroups property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"viewergroups":{"type":"array","description":"Data for viewergroups.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for status."},"name":{"type":"string","description":"Value of name","readOnly":true},"viewers":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_viewers":{"type":"object","description":"Because the list of portals attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"type":{"type":"string","description":"Value of type","readOnly":true}}}},"$moreChildren_viewergroups":{"type":"object","description":"Because the list of portals attached to the viewergroups property is limited (by the `maxchildren` parameter), this block allows to describe the portals obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portals","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portals","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portals (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portals."}}},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"activated":{"description":"Faces (form input field behavior according to the data)"},"portal":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"state":{"description":"Faces (form input field behavior according to the data)"},"firstitems":{"description":"Faces (form input field behavior according to the data)"},"team":{"description":"Faces (form input field behavior according to the data)"},"viewers":{"description":"Faces (form input field behavior according to the data)"},"logo":{"description":"Faces (form input field behavior according to the data)"},"cover":{"description":"Faces (form input field behavior according to the data)"},"descriptionhtml":{"description":"Faces (form input field behavior according to the data)"},"descriptionhtmlfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionhtmlde":{"description":"Faces (form input field behavior according to the data)"},"private":{"description":"Faces (form input field behavior according to the data)"},"newestitems":{"description":"Faces (form input field behavior according to the data)"},"visibility":{"description":"Faces (form input field behavior according to the data)"},"subtitle":{"description":"Faces (form input field behavior according to the data)"},"subtitlefr":{"description":"Faces (form input field behavior according to the data)"},"subtitlede":{"description":"Faces (form input field behavior according to the data)"},"bookmarks":{"description":"Faces (form input field behavior according to the data)"},"portaltheme":{"description":"Faces (form input field behavior according to the data)"},"teamgroups":{"description":"Faces (form input field behavior according to the data)"},"viewergroups":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-portalbookmark":{"type":"object","title":"portalbookmark","description":"Data structure of resource portalbookmark. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for status.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"type":{"type":"string","description":"Value of type"},"portal":{"properties":{"cover":{"type":"object","description":"Data for banner property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123/cover"}},"readOnly":true}},"description":"Data for portals.\n\n\n\n> The base structure of the portals functionality. \n"},"cart":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for cart."},"link":{"type":"string","description":"Value of URL"},"position":{"type":"integer","format":"int32","description":"Value of position"},"logo":{"type":"object","description":"Data for custom thumbnail property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portalbookmark/123/logo"}}},"visibility":{"type":"string","description":"Value of terms of use"},"teamgroups":{"type":"array","description":"Data for teamgroups.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_teamgroups":{"type":"object","description":"Because the list of portalbookmark attached to the teamgroups property is limited (by the `maxchildren` parameter), this block allows to describe the portalbookmark obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portalbookmark","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portalbookmark","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portalbookmark (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portalbookmark."}}},"viewergroups":{"type":"array","description":"Data for viewergroups.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_viewergroups":{"type":"object","description":"Because the list of portalbookmark attached to the viewergroups property is limited (by the `maxchildren` parameter), this block allows to describe the portalbookmark obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of portalbookmark","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of portalbookmark","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following portalbookmark (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following portalbookmark."}}},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"type":{"description":"Faces (form input field behavior according to the data)"},"portal":{"description":"Faces (form input field behavior according to the data)"},"cart":{"description":"Faces (form input field behavior according to the data)"},"link":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"logo":{"description":"Faces (form input field behavior according to the data)"},"visibility":{"description":"Faces (form input field behavior according to the data)"},"teamgroups":{"description":"Faces (form input field behavior according to the data)"},"viewergroups":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-portaldownload":{"type":"object","title":"portaldownload","description":"Data structure of resource portaldownload. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"portal":{"type":"string","description":"Value of portal"},"uuids":{"type":"string","description":"Value of uuids"},"data":{"type":"string","description":"Value of data"},"expires":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of expires"},"query":{"type":"string","description":"Value of query"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"portal":{"description":"Faces (form input field behavior according to the data)"},"uuids":{"description":"Faces (form input field behavior according to the data)"},"data":{"description":"Faces (form input field behavior according to the data)"},"expires":{"description":"Faces (form input field behavior according to the data)"},"query":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-portaltheme":{"type":"object","title":"portaltheme","description":"Data structure of resource portaltheme. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"namede":{"type":"string","description":"Value of name (DE)"},"namefr":{"type":"string","description":"Value of name (FR)"},"favicon":{"type":"object","description":"Data for favicon property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/portaltheme/123/favicon"}}},"props":{"type":"string","description":"Value of props"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"favicon":{"description":"Faces (form input field behavior according to the data)"},"props":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-product":{"type":"object","title":"product","description":"Data structure of resource product. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"description":{"type":"string","description":"Value of description"},"release_date":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date"}],"description":"Value of delivery date"},"sku":{"type":"string","description":"Value of SKU"},"hero":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for product asset.\n\n\n\n> Product asset for 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"},"assets":{"type":"array","description":"Data for product asset.\n\n\n\n> Product asset for 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","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}}}},"$moreChildren_assets":{"type":"object","description":"Because the list of product attached to the product asset property is limited (by the `maxchildren` parameter), this block allows to describe the product obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of product","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of product","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following product (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following product."}}},"productcategory":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of family","readOnly":true}},"description":"Data for product category."},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for organization."},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"release_date":{"description":"Faces (form input field behavior according to the data)"},"sku":{"description":"Faces (form input field behavior according to the data)"},"hero":{"description":"Faces (form input field behavior according to the data)"},"assets":{"description":"Faces (form input field behavior according to the data)"},"productcategory":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-productcategory":{"type":"object","title":"product category","description":"Data structure of resource product category. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color.","readOnly":true},"published":{"type":"boolean","description":"Value of published","readOnly":true},"online":{"type":"boolean","description":"Value of online?","readOnly":true},"archived":{"type":"boolean","description":"Value of is archived ?","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of family"},"parentcategory":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of family","readOnly":true}},"description":"Data for product category."},"namede":{"type":"string","description":"Value of name (DE)"},"namefr":{"type":"string","description":"Value of name (FR)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"parentcategory":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-rekouser":{"type":"object","title":"rekouser","description":"Data structure of resource rekouser. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"rekouserid":{"type":"string","description":"Value of rekouserid"},"firstname":{"type":"string","description":"Value of first name"},"avatar":{"type":"object","description":"Data for avatar property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/rekouser/123/avatar"}}},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"rekouserid":{"description":"Faces (form input field behavior according to the data)"},"firstname":{"description":"Faces (form input field behavior according to the data)"},"avatar":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-resolution":{"type":"object","title":"resolution","description":"Data structure of resource resolution. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name"},"shortname":{"type":"string","description":"Value of shortname"},"nature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"code":{"type":"string","description":"Value of code","readOnly":true}},"description":"Data for asset type."},"description":{"type":"string","description":"Value of description"},"position":{"type":"integer","format":"int32","description":"Value of position","readOnly":true},"variation":{"type":"string","description":"Value of variation"},"namefr":{"type":"string","description":"Value of name (FR)","writeOnly":true},"namede":{"type":"string","description":"Value of name (DE)","writeOnly":true},"descriptionfr":{"type":"string","description":"Value of description (FR)","writeOnly":true},"descriptionde":{"type":"string","description":"Value of description (DE)","writeOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"shortname":{"description":"Faces (form input field behavior according to the data)"},"nature":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"variation":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-reversesearch":{"type":"object","title":"reverse search","description":"Data structure of resource reverse search. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"assetuuid":{"type":"string","description":"Value of asset reference"},"state":{"type":"string","description":"Value of state"},"lastrefresh":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of last refresh date"},"domains":{"type":"array","description":"Data for reverse search domain.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of domain","readOnly":true},"bestscore":{"type":"integer","format":"int32","description":"Value of best score","readOnly":true},"matches":{"type":"array","description":"Data for reverse search match.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_matches":{"type":"object","description":"Because the list of reverse search attached to the reverse search match property is limited (by the `maxchildren` parameter), this block allows to describe the reverse search obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of reverse search","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of reverse search","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following reverse search (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following reverse search."}}},"state":{"type":"string","description":"Value of state","readOnly":true},"preview":{"type":"object","description":"Data for preview property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearch/123/preview"}},"readOnly":true},"nbresults":{"type":"integer","format":"int32","description":"Value of number of results","readOnly":true},"nbok":{"type":"integer","format":"int32","description":"Value of number of OK results","readOnly":true},"nberror":{"type":"integer","format":"int32","description":"Value of number of inactive results","readOnly":true},"nbwarning":{"type":"integer","format":"int32","description":"Value of number of warning results","readOnly":true},"nbpending":{"type":"integer","format":"int32","description":"Value of number of pending results","readOnly":true},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date","readOnly":true}}}},"$moreChildren_domains":{"type":"object","description":"Because the list of reverse search attached to the reverse search domain property is limited (by the `maxchildren` parameter), this block allows to describe the reverse search obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of reverse search","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of reverse search","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following reverse search (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following reverse search."}}},"initiator":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user."},"nbdomains":{"type":"integer","format":"int32","description":"Value of number of matching domains"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"assetuuid":{"description":"Faces (form input field behavior according to the data)"},"state":{"description":"Faces (form input field behavior according to the data)"},"lastrefresh":{"description":"Faces (form input field behavior according to the data)"},"domains":{"description":"Faces (form input field behavior according to the data)"},"initiator":{"description":"Faces (form input field behavior according to the data)"},"nbdomains":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-reversesearchdomain":{"type":"object","title":"reverse search domain","description":"Data structure of resource reverse search domain. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of domain"},"bestscore":{"type":"integer","format":"int32","description":"Value of best score"},"matches":{"type":"array","description":"Data for reverse search match.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"preview":{"type":"object","description":"Data for preview property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123/preview"}},"readOnly":true},"score":{"type":"integer","format":"int32","description":"Value of image score","readOnly":true},"url":{"type":"string","description":"Value of image URL","readOnly":true},"backlinks":{"type":"array","description":"Data for reverse search page.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_backlinks":{"type":"object","description":"Because the list of reverse search domain attached to the reverse search page property is limited (by the `maxchildren` parameter), this block allows to describe the reverse search domain obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of reverse search domain","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of reverse search domain","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following reverse search domain (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following reverse search domain."}}},"isdxm":{"type":"boolean","description":"Value of is a media delivery image","readOnly":true},"nbok":{"type":"integer","format":"int32","description":"Value of number of OK results","readOnly":true},"nbwarning":{"type":"integer","format":"int32","description":"Value of number of warning results","readOnly":true},"nberror":{"type":"integer","format":"int32","description":"Value of number of inactive results","readOnly":true},"nbpending":{"type":"integer","format":"int32","description":"Value of number of pending results","readOnly":true},"state":{"type":"string","description":"Value of state","readOnly":true},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date","readOnly":true}}}},"$moreChildren_matches":{"type":"object","description":"Because the list of reverse search domain attached to the reverse search match property is limited (by the `maxchildren` parameter), this block allows to describe the reverse search domain obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of reverse search domain","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of reverse search domain","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following reverse search domain (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following reverse search domain."}}},"assetuuid":{"type":"string","description":"Value of asset reference"},"state":{"type":"string","description":"Value of state"},"preview":{"type":"object","description":"Data for preview property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchdomain/123/preview"}}},"nbresults":{"type":"integer","format":"int32","description":"Value of number of results"},"nbok":{"type":"integer","format":"int32","description":"Value of number of OK results"},"nberror":{"type":"integer","format":"int32","description":"Value of number of inactive results"},"nbwarning":{"type":"integer","format":"int32","description":"Value of number of warning results"},"nbpending":{"type":"integer","format":"int32","description":"Value of number of pending results"},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"bestscore":{"description":"Faces (form input field behavior according to the data)"},"matches":{"description":"Faces (form input field behavior according to the data)"},"assetuuid":{"description":"Faces (form input field behavior according to the data)"},"state":{"description":"Faces (form input field behavior according to the data)"},"preview":{"description":"Faces (form input field behavior according to the data)"},"nbresults":{"description":"Faces (form input field behavior according to the data)"},"nbok":{"description":"Faces (form input field behavior according to the data)"},"nberror":{"description":"Faces (form input field behavior according to the data)"},"nbwarning":{"description":"Faces (form input field behavior according to the data)"},"nbpending":{"description":"Faces (form input field behavior according to the data)"},"discoverydate":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-reversesearchmatch":{"type":"object","title":"reverse search match","description":"Data structure of resource reverse search match. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"preview":{"type":"object","description":"Data for preview property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/reversesearchmatch/123/preview"}}},"assetuuid":{"type":"string","description":"Value of asset reference"},"score":{"type":"integer","format":"int32","description":"Value of image score"},"url":{"type":"string","description":"Value of image URL"},"backlinks":{"type":"array","description":"Data for reverse search page.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"url":{"type":"string","description":"Value of page URL","readOnly":true},"state":{"type":"string","description":"Value of state","readOnly":true},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date","readOnly":true},"lastcrawleddate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of last crawled date","readOnly":true},"pagestatus":{"type":"string","description":"Value of page status","readOnly":true},"sources":{"type":"string","description":"Value of sources","readOnly":true}}}},"$moreChildren_backlinks":{"type":"object","description":"Because the list of reverse search match attached to the reverse search page property is limited (by the `maxchildren` parameter), this block allows to describe the reverse search match obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of reverse search match","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of reverse search match","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following reverse search match (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following reverse search match."}}},"isdxm":{"type":"boolean","description":"Value of is a media delivery image"},"nbok":{"type":"integer","format":"int32","description":"Value of number of OK results"},"nbwarning":{"type":"integer","format":"int32","description":"Value of number of warning results"},"nberror":{"type":"integer","format":"int32","description":"Value of number of inactive results"},"nbpending":{"type":"integer","format":"int32","description":"Value of number of pending results"},"state":{"type":"string","description":"Value of state"},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date","readOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"preview":{"description":"Faces (form input field behavior according to the data)"},"assetuuid":{"description":"Faces (form input field behavior according to the data)"},"score":{"description":"Faces (form input field behavior according to the data)"},"url":{"description":"Faces (form input field behavior according to the data)"},"backlinks":{"description":"Faces (form input field behavior according to the data)"},"isdxm":{"description":"Faces (form input field behavior according to the data)"},"nbok":{"description":"Faces (form input field behavior according to the data)"},"nbwarning":{"description":"Faces (form input field behavior according to the data)"},"nberror":{"description":"Faces (form input field behavior according to the data)"},"nbpending":{"description":"Faces (form input field behavior according to the data)"},"state":{"description":"Faces (form input field behavior according to the data)"},"discoverydate":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-reversesearchpage":{"type":"object","title":"reverse search page","description":"Data structure of resource reverse search page. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"assetuuid":{"type":"string","description":"Value of asset reference"},"url":{"type":"string","description":"Value of page URL"},"state":{"type":"string","description":"Value of state"},"discoverydate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of discovery date"},"lastcrawleddate":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of last crawled date"},"pagestatus":{"type":"string","description":"Value of page status"},"sources":{"type":"string","description":"Value of sources"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"assetuuid":{"description":"Faces (form input field behavior according to the data)"},"url":{"description":"Faces (form input field behavior according to the data)"},"state":{"description":"Faces (form input field behavior according to the data)"},"discoverydate":{"description":"Faces (form input field behavior according to the data)"},"lastcrawleddate":{"description":"Faces (form input field behavior according to the data)"},"pagestatus":{"description":"Faces (form input field behavior according to the data)"},"sources":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-role":{"type":"object","title":"role","description":"Data structure of resource role. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 2.","readOnly":true},"name":{"type":"string","description":"Value of name"},"infos":{"type":"string","description":"Value of description"},"rubrique":{"type":"array","description":"Data for menu.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}},"writeOnly":true},"$moreChildren_rubrique":{"type":"object","description":"Because the list of role attached to the menu property is limited (by the `maxchildren` parameter), this block allows to describe the role obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of role","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of role","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following role (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following role."}}},"namefr":{"type":"string","description":"Value of name (FR)"},"infosfr":{"type":"string","description":"Value of infos (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"resolutions":{"type":"array","description":"Data for allowed download resolutions.","items":{"properties":{"shortname":{"type":"string","description":"Value of shortname","readOnly":true},"nature":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for asset type.","writeOnly":true},"description":{"type":"string","description":"Value of description","readOnly":true},"variation":{"type":"string","description":"Value of variation","readOnly":true}}},"writeOnly":true},"$moreChildren_resolutions":{"type":"object","description":"Because the list of role attached to the allowed download resolutions property is limited (by the `maxchildren` parameter), this block allows to describe the role obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of role","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of role","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following role (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following role."}}},"infosde":{"type":"string","description":"Value of infosde"},"pkgroletemplate":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for role type."},"isdefaultexternal":{"type":"boolean","description":"Value of default role for external users"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"infos":{"description":"Faces (form input field behavior according to the data)"},"rubrique":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"infosfr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"resolutions":{"description":"Faces (form input field behavior according to the data)"},"infosde":{"description":"Faces (form input field behavior according to the data)"},"pkgroletemplate":{"description":"Faces (form input field behavior according to the data)"},"isdefaultexternal":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-user":{"type":"object","title":"user","description":"Data structure of resource user. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for users workflow.","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true},"login":{"type":"string","description":"Value of login"},"role":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for role.","readOnly":true},"email":{"type":"string","description":"Value of email"},"bolang":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for language."},"contriblangs":{"type":"array","description":"Data for language.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_contriblangs":{"type":"object","description":"Because the list of user attached to the language property is limited (by the `maxchildren` parameter), this block allows to describe the user obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of user","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of user","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following user (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following user."}}},"type":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for user type."},"groups":{"type":"array","description":"Data for brands.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}}}},"$moreChildren_groups":{"type":"object","description":"Because the list of user attached to the brands property is limited (by the `maxchildren` parameter), this block allows to describe the user obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of user","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of user","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following user (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following user."}}},"parentgroup":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for user."},"lastpasschanged":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of last change password","readOnly":true},"changepass":{"type":"boolean","description":"Value of change password at next logon"},"deactivateonnbrfail":{"type":"integer","format":"int32","description":"Value of no. of attempts before disabling the account"},"nbrconnexionfailed":{"type":"integer","format":"int32","description":"Value of number of failed connections","readOnly":true},"lastdateconnected":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of lastdateconnected","readOnly":true},"avatar":{"type":"object","description":"Data for avatar property (binary content)","properties":{"serverPath":{"type":"string","description":"File path or file name"},"$type":{"type":"string","description":"Media type","enum":["IMAGE","VIDEO","AUDIO","OFFICE","DTP","DTPZIP","PDF","DIR","UNKNOWN","NONE"],"readOnly":true},"$mimetype":{"type":"string","description":"File mime type","format":"mimetype","readOnly":true},"$variations":{"type":"array","description":"List of available variations","items":{"type":"string","enum":["thumbnailTiny","thumbnailSmall","thumbnailBig","thumbnailReal","pdf","zip","wxml","html"]},"readOnly":true},"$presets":{"type":"array","description":"List of available presets","items":{"type":"string"},"readOnly":true},"$metadata":{"type":"object","description":"metadata of the file","properties":{"author":{"type":"string","description":"Author of the media","readOnly":true},"colorSpace":{"type":"string","description":"Color space of the media","readOnly":true},"equipmentModel":{"type":"string","description":"Equipment model that produced the media","readOnly":true},"manufacturer":{"type":"string","description":"Manufacturer of the equipment model","readOnly":true},"duration":{"type":"number","format":"double","description":"Duration of the video (In seconds)","readOnly":true},"properties":{"type":"object","description":"Metadata (IPTC, EXIF...) of media as list of couples *property=value*","readOnly":true,"additionalProperties":true,"example":{"exif:datetimeoriginal":"2014:12:22 10:37:54"}}},"readOnly":true},"$href":{"type":"string","format":"uri","description":"URI to get the binary file","readOnly":true,"example":"https://club-wed.wedia-group.com:443/api/rest/dam/data/user/123/avatar"}}},"internal":{"type":"boolean","description":"Value of internal"},"lastname":{"type":"string","description":"Value of last name"},"organization":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for organization."},"firstname":{"type":"string","description":"Value of first name"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"login":{"description":"Faces (form input field behavior according to the data)"},"role":{"description":"Faces (form input field behavior according to the data)"},"email":{"description":"Faces (form input field behavior according to the data)"},"bolang":{"description":"Faces (form input field behavior according to the data)"},"contriblangs":{"description":"Faces (form input field behavior according to the data)"},"type":{"description":"Faces (form input field behavior according to the data)"},"groups":{"description":"Faces (form input field behavior according to the data)"},"parentgroup":{"description":"Faces (form input field behavior according to the data)"},"lastpasschanged":{"description":"Faces (form input field behavior according to the data)"},"changepass":{"description":"Faces (form input field behavior according to the data)"},"deactivateonnbrfail":{"description":"Faces (form input field behavior according to the data)"},"nbrconnexionfailed":{"description":"Faces (form input field behavior according to the data)"},"lastdateconnected":{"description":"Faces (form input field behavior according to the data)"},"avatar":{"description":"Faces (form input field behavior according to the data)"},"internal":{"description":"Faces (form input field behavior according to the data)"},"lastname":{"description":"Faces (form input field behavior according to the data)"},"organization":{"description":"Faces (form input field behavior according to the data)"},"firstname":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-usergroup":{"type":"object","title":"usergroup","description":"Data structure of resource usergroup. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"owner":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}},"description":"Data for user.","readOnly":true},"name":{"type":"string","description":"Value of name"},"description":{"type":"string","description":"Value of description"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"namees":{"type":"string","description":"Value of name (Spanish)"},"descriptionfr":{"type":"string","description":"Value of description (FR)","writeOnly":true},"descriptionde":{"type":"string","description":"Value of description (DE)","writeOnly":true},"descriptiones":{"type":"string","description":"Value of descriptiones","writeOnly":true},"team":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}}}},"$moreChildren_team":{"type":"object","description":"Because the list of usergroup attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the usergroup obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of usergroup","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of usergroup","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following usergroup (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following usergroup."}}},"viewers":{"type":"array","description":"Data for user.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of display name","readOnly":true}}}},"$moreChildren_viewers":{"type":"object","description":"Because the list of usergroup attached to the user property is limited (by the `maxchildren` parameter), this block allows to describe the usergroup obtained and how to obtain the following ones","properties":{"first":{"type":"integer","format":"int32","description":"The index of the first item in the whole set of usergroup","example":0},"count":{"type":"integer","format":"int32","description":"The number of the items exported in this response","example":20},"total":{"type":"integer","format":"int32","description":"The number of the items in the whole set of usergroup","example":88},"nextToken":{"type":"string","description":"A token to get the list of the following usergroup (used with 'children' end point, see sibling `nextHref`)"},"nextHref":{"type":"string","description":"A URI endpoint to get the list of the following usergroup."}}},"type":{"type":"string","description":"Value of type"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"owner":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"description":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"},"namees":{"description":"Faces (form input field behavior according to the data)"},"descriptionfr":{"description":"Faces (form input field behavior according to the data)"},"descriptionde":{"description":"Faces (form input field behavior according to the data)"},"descriptiones":{"description":"Faces (form input field behavior according to the data)"},"team":{"description":"Faces (form input field behavior according to the data)"},"viewers":{"description":"Faces (form input field behavior according to the data)"},"type":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-userregistration":{"type":"object","title":"user pending approval","description":"Data structure of resource user pending approval. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true},"activated":{"type":"boolean","description":"Value of active","readOnly":true},"role":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"name":{"type":"string","description":"Value of name","readOnly":true}},"description":"Data for role.","readOnly":true},"lastname":{"type":"string","description":"Value of name"},"firstname":{"type":"string","description":"Value of first name"},"company":{"type":"string","description":"Value of company"},"login":{"type":"string","description":"Value of email"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"activated":{"description":"Faces (form input field behavior according to the data)"},"role":{"description":"Faces (form input field behavior according to the data)"},"lastname":{"description":"Faces (form input field behavior according to the data)"},"firstname":{"description":"Faces (form input field behavior according to the data)"},"company":{"description":"Faces (form input field behavior according to the data)"},"login":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-videoratio":{"type":"object","title":"videoratio","description":"Data structure of resource videoratio. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"code":{"type":"string","description":"Value of code"},"namefr":{"type":"string","description":"Value of name (FR)","writeOnly":true},"namede":{"type":"string","description":"Value of name (DE)","writeOnly":true},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"code":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-vincent":{"type":"object","title":"vincent","description":"Data structure of resource vincent. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for workflow 1.","readOnly":true},"name":{"type":"string","description":"Value of name"},"namefr":{"type":"string","description":"Value of name (FR)"},"namede":{"type":"string","description":"Value of name (DE)"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"status":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"namefr":{"description":"Faces (form input field behavior according to the data)"},"namede":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-wkfasset":{"type":"object","title":"wkfasset","description":"Data structure of resource wkfasset. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color."},"published":{"type":"boolean","description":"Value of published"},"isonline":{"type":"boolean","description":"Value of online?"},"isarchived":{"type":"boolean","description":"Value of is archived ?"},"position":{"type":"integer","format":"int32","description":"Value of position"},"onenter":{"type":"string","description":"Value of on enter"},"onleave":{"type":"string","description":"Value of on leave"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"color":{"description":"Faces (form input field behavior according to the data)"},"published":{"description":"Faces (form input field behavior according to the data)"},"isonline":{"description":"Faces (form input field behavior according to the data)"},"isarchived":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"onenter":{"description":"Faces (form input field behavior according to the data)"},"onleave":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-wkfpkgportal":{"type":"object","title":"wkfpkgportal","description":"Data structure of resource wkfpkgportal. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color."},"published":{"type":"boolean","description":"Value of published"},"isonline":{"type":"boolean","description":"Value of online?"},"isarchived":{"type":"boolean","description":"Value of is archived ?"},"position":{"type":"integer","format":"int32","description":"Value of position"},"onenter":{"type":"string","description":"Value of on enter"},"onleave":{"type":"string","description":"Value of on leave"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"color":{"description":"Faces (form input field behavior according to the data)"},"published":{"description":"Faces (form input field behavior according to the data)"},"isonline":{"description":"Faces (form input field behavior according to the data)"},"isarchived":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"onenter":{"description":"Faces (form input field behavior according to the data)"},"onleave":{"description":"Faces (form input field behavior according to the data)"}}}}},"resource-wkfpkgskmetadata":{"type":"object","title":"workflow 1","description":"Data structure of resource workflow 1. \n\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true},"created":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of creation date","readOnly":true},"modified":{"oneOf":[{"type":"integer","format":"int64"},{"type":"string","format":"date-time"}],"description":"Value of update date","readOnly":true},"name":{"type":"string","description":"Value of name"},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id","readOnly":true},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID","readOnly":true}},"description":"Data for color."},"published":{"type":"boolean","description":"Value of published"},"isonline":{"type":"boolean","description":"Value of online?"},"isarchived":{"type":"boolean","description":"Value of is archived ?"},"position":{"type":"integer","format":"int32","description":"Value of position"},"onenter":{"type":"string","description":"Value of on enter"},"onleave":{"type":"string","description":"Value of on leave"},"$faces":{"type":"object","description":"Faces (form input field behavior according to the data)","properties":{"id":{"description":"Faces (form input field behavior according to the data)"},"created":{"description":"Faces (form input field behavior according to the data)"},"modified":{"description":"Faces (form input field behavior according to the data)"},"name":{"description":"Faces (form input field behavior according to the data)"},"color":{"description":"Faces (form input field behavior according to the data)"},"published":{"description":"Faces (form input field behavior according to the data)"},"isonline":{"description":"Faces (form input field behavior according to the data)"},"isarchived":{"description":"Faces (form input field behavior according to the data)"},"position":{"description":"Faces (form input field behavior according to the data)"},"onenter":{"description":"Faces (form input field behavior according to the data)"},"onleave":{"description":"Faces (form input field behavior according to the data)"}}}}}}},"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"}}